From 4c3b1b9fca4c4d61dc0414b299fb8f020b7b78cd Mon Sep 17 00:00:00 2001 From: Shruti Wasnik Date: Wed, 5 Mar 2025 17:50:30 +0530 Subject: [PATCH] add data plane typespec for sustainability services --- .../client.tsp | 67 + ...ice_CalculateEmissions_MaximumSet_Gen.json | 74 + ...ice_CalculateEmissions_MinimumSet_Gen.json | 45 + ...ce_GetCalculationModel_MaximumSet_Gen.json | 44 + ...vice_GetEmissionFactor_MaximumSet_Gen.json | 109 + ...ce_GetEstimationFactor_MaximumSet_Gen.json | 44 + ...rvice_GetFactorLibrary_MaximumSet_Gen.json | 22 + ...rvice_GetFactorMapping_MaximumSet_Gen.json | 59 + ...tReferenceEntityRecord_MaximumSet_Gen.json | 17 + ..._ListCalculationModels_MaximumSet_Gen.json | 49 + ..._ListCalculationModels_MinimumSet_Gen.json | 29 + ...FactorsByFactorLibrary_MaximumSet_Gen.json | 114 + ...FactorsByFactorLibrary_MaximumSet_Gen.json | 49 + ...ce_ListFactorLibraries_MaximumSet_Gen.json | 27 + ...ce_ListFactorLibraries_MinimumSet_Gen.json | 20 + ...ice_ListFactorMappings_MaximumSet_Gen.json | 64 + ..._ListReferenceEntities_MaximumSet_Gen.json | 22 + ..._ListReferenceEntities_MinimumSet_Gen.json | 20 + ...ReferenceEntityRecords_MaximumSet_Gen.json | 22 + ...ReferenceEntityRecords_MinimumSet_Gen.json | 20 + .../Microsoft.SustainabilityServices/main.tsp | 40 + .../models/emissioncalculation.tsp | 217 ++ .../models/factorlibrary.tsp | 202 ++ .../models/othermodels.tsp | 72 + .../models/referencedata.tsp | 39 + .../routes.tsp | 92 + .../tspconfig.yaml | 40 + .../sustainabilityservices/cspell.yaml | 12 + ...ice_CalculateEmissions_MaximumSet_Gen.json | 74 + ...ice_CalculateEmissions_MinimumSet_Gen.json | 45 + ...ce_GetCalculationModel_MaximumSet_Gen.json | 44 + ...vice_GetEmissionFactor_MaximumSet_Gen.json | 109 + ...ce_GetEstimationFactor_MaximumSet_Gen.json | 44 + ...rvice_GetFactorLibrary_MaximumSet_Gen.json | 22 + ...rvice_GetFactorMapping_MaximumSet_Gen.json | 59 + ...tReferenceEntityRecord_MaximumSet_Gen.json | 17 + ..._ListCalculationModels_MaximumSet_Gen.json | 49 + ..._ListCalculationModels_MinimumSet_Gen.json | 29 + ...FactorsByFactorLibrary_MaximumSet_Gen.json | 114 + ...FactorsByFactorLibrary_MaximumSet_Gen.json | 49 + ...ce_ListFactorLibraries_MaximumSet_Gen.json | 27 + ...ce_ListFactorLibraries_MinimumSet_Gen.json | 20 + ...ice_ListFactorMappings_MaximumSet_Gen.json | 64 + ..._ListReferenceEntities_MaximumSet_Gen.json | 22 + ..._ListReferenceEntities_MinimumSet_Gen.json | 20 + ...ReferenceEntityRecords_MaximumSet_Gen.json | 22 + ...ReferenceEntityRecords_MinimumSet_Gen.json | 20 + .../preview/2025-01-01-preview/openapi.json | 2270 +++++++++++++++++ .../data-plane/readme.md | 50 + 49 files changed, 4801 insertions(+) create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/client.tsp create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/main.tsp create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/models/emissioncalculation.tsp create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/models/factorlibrary.tsp create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/models/othermodels.tsp create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/models/referencedata.tsp create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/routes.tsp create mode 100644 specification/sustainabilityservices/Microsoft.SustainabilityServices/tspconfig.yaml create mode 100644 specification/sustainabilityservices/cspell.yaml create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json create mode 100644 specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/openapi.json create mode 100644 specification/sustainabilityservices/data-plane/readme.md diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/client.tsp b/specification/sustainabilityservices/Microsoft.SustainabilityServices/client.tsp new file mode 100644 index 000000000000..4174bf91c663 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/client.tsp @@ -0,0 +1,67 @@ +import "@azure-tools/typespec-client-generator-core"; +import "./main.tsp"; + +using Azure.ClientGenerator.Core; + +namespace Microsoft.SustainabilityServices; + +@client({ + name: "SustainabilityServiceClient", + service: Microsoft.SustainabilityServices, +}) +interface SustainabilityServiceClient { + @clientName("ListFactorLibraries", "csharp") + @clientName("list_factor_libraries", "python") + listFactorLibraries is SustainabilityService.listFactorLibraries; + + @clientName("GetFactorLibrary", "csharp") + @clientName("get_factor_library", "python") + getFactorLibrary is SustainabilityService.getFactorLibrary; + + @clientName("ListEstimationFactorsByFactorLibrary", "csharp") + @clientName("list_estimation_factors_by_factor_library", "python") + listEstimationFactorsByFactorLibrary is SustainabilityService.listEstimationFactorsByFactorLibrary; + + @clientName("GetEstimationFactor", "csharp") + @clientName("get_estimation_factor", "python") + getEstimationFactor is SustainabilityService.getEstimationFactor; + + @clientName("ListEmissionFactorsByFactorLibrary", "csharp") + @clientName("list_emission_factors_by_factor_library", "python") + listEmissionFactorsByFactorLibrary is SustainabilityService.listEmissionFactorsByFactorLibrary; + + @clientName("GetEmissionFactor", "csharp") + @clientName("get_emission_factor", "python") + getEmissionFactor is SustainabilityService.getEmissionFactor; + + @clientName("ListFactorMappings", "csharp") + @clientName("list_factor_mappings", "python") + listFactorMappings is SustainabilityService.listFactorMappings; + + @clientName("GetFactorMapping", "csharp") + @clientName("get_factor_mapping", "python") + getFactorMapping is SustainabilityService.getFactorMapping; + + @clientName("ListCalculationModels", "csharp") + @clientName("list_calculation_models", "python") + listCalculationModels is SustainabilityService.listCalculationModels; + + @clientName("GetCalculationModel", "csharp") + @clientName("get_calculation_model", "python") + getCalculationModel is SustainabilityService.getCalculationModel; + + @clientName("ListReferenceEntities", "csharp") + @clientName("list_reference_entities", "python") + listReferenceEntities is SustainabilityService.listReferenceEntities; + + @clientName("ListReferenceEntityData", "csharp") + @clientName("list_reference_entity_data", "python") + listReferenceEntityRecords is SustainabilityService.listReferenceEntityRecords; + + @clientName("GetReferenceEntityData", "csharp") + @clientName("get_reference_entity_data", "python") + getReferenceEntityRecords is SustainabilityService.getReferenceEntityRecord; + + @clientName("Calculate", "csharp") + calculate is SustainabilityService.calculateEmissions; +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json new file mode 100644 index 000000000000..ef580b9d3f9e --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "SustainabilityService_CalculateEmissions_MaximumSet", + "operationId": "SustainabilityService_CalculateEmissions", + "parameters": { + "api-version": "2025-01-01-preview", + "body": { + "timeStamp": "2025-03-05T07:25:40.609Z", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "arVersion": "Custom", + "activities": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityData": {} + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "status": "Succeeded", + "successfulActivities": 6, + "failedActivities": 12, + "excludedActivities": 1, + "processedActivities": 9 + }, + "errorDetails": [ + { + "activityId": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityName": "agxovdvljfxgsxvtyf", + "message": "wgyz", + "code": "liryrrxbbgxkavfmjfcwjtrjluqg" + } + ], + "activityEmissionOutput": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissions": [ + { + "ch4": 9, + "ch4Unit": "tbdfmm", + "co2": 17, + "co2Unit": "gnxxtgszgon", + "co2e": 5, + "co2eUnit": "owepcjpaoxlmkpstpofkcjwg", + "co2emt": 27, + "hfcs": 17, + "hfcsUnit": "lrnesztablxhxymmusywxswgpxpx", + "n2o": 11, + "n2oUnit": "fczxflvwikmymdfttjfwhvenwz", + "nf3": 1, + "nf3Unit": "xctbgnnxeqiijmjmsocfvqxds", + "pfcs": 5, + "pfcsUnit": "vbdvqpbxrxovj", + "otherGhgs": 1, + "otherGhgsUnit": "nnghkaxryvazxcnkfgqikrggwfzb", + "sf6": 11, + "sf6Unit": "djgebfbyzjgfxslhhmvipd", + "isMarketBased": true, + "isBiogenic": true, + "emissionCalculationModel": "rf", + "calculationLibrary": "xcoypozdrjrgqyyrfotonpkobua", + "emissionFactor": "shfuzrdkggeabfwxpj", + "adjustedActualQuantity": "nmeqfk", + "adjustedActualQuantityUnit": "wpcobpvcffibmmmvrqwolvdpgoijl" + } + ] + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json new file mode 100644 index 000000000000..747996b22cb3 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "SustainabilityService_CalculateEmissions_MinimumSet", + "operationId": "SustainabilityService_CalculateEmissions", + "parameters": { + "api-version": "2025-01-01-preview", + "body": { + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "activities": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityData": {} + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "status": "Succeeded", + "successfulActivities": 6, + "failedActivities": 12, + "excludedActivities": 1, + "processedActivities": 9 + }, + "errorDetails": [ + { + "activityId": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityName": "agxovdvljfxgsxvtyf", + "message": "wgyz", + "code": "liryrrxbbgxkavfmjfcwjtrjluqg" + } + ], + "activityEmissionOutput": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissions": [ + {} + ] + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json new file mode 100644 index 000000000000..e1c13e4baaf9 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "SustainabilityService_GetCalculationModel_MaximumSet", + "operationId": "SustainabilityService_GetCalculationModel", + "parameters": { + "api-version": "2025-01-01-preview", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "entityName": "mrgyzzhuyw", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "calculationFlowJson": "g", + "calculationMethod": "vssewtlgtulccramolznv", + "dataDefinitionId": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "xpblerxeeftidqjyvtcmilzgvhktz", + "emissionCalculationId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionSource": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "modelJsonVersion": "nr", + "name": "guftftnectufbgwipbhhecaqsiyqm", + "sustainabilitymodule": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "type": "pwrdfsnaqq" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dff8ef87bf9 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json @@ -0,0 +1,109 @@ +{ + "title": "SustainabilityService_GetEmissionFactor_MaximumSet", + "operationId": "SustainabilityService_GetEmissionFactor", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionFactorId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "entityName": "mhysdemejmnlrixkibxbdpulaclivw", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "ch4": 15, + "ch4Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2": 12, + "co2Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2e": 1, + "co2eUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "tjvhdxkfzubx", + "emissionFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "hfcs": 11, + "hfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "isBiofuel": true, + "name": "jprosbghrgieuoltgmecmdysjj", + "nf3": 22, + "nf3Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "n2o": 12, + "n2oUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "otherGhgs": 25, + "otherGhgsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "pfcs": 24, + "pfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "sf6": 8, + "sf6Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "subtype": "oaslhlpcquf", + "type": "wtihrlbbaftknflb", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json new file mode 100644 index 000000000000..494768741dba --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "SustainabilityService_GetEstimationFactor_MaximumSet", + "operationId": "SustainabilityService_GetEstimationFactor", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "estimationFactorId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "entityName": "dxp", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "documentationReference": "mpzznkdybhkf", + "estimationFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "factorValue": 19, + "factorValueUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "yribs", + "subtype": "opuhkswrndvdihbnxj", + "type": "oaijjfbo", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json new file mode 100644 index 000000000000..697cbfa0e529 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "SustainabilityService_GetFactorLibrary_MaximumSet", + "operationId": "SustainabilityService_GetFactorLibrary", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "name": "xxjsatedcocthjfjzzkuhxk", + "libraryType": "eklvmkzxqance", + "attribution": "gortdjkgmtn", + "version": "zplrzyy", + "description": "cfrtht", + "datePublished": "qeumvdzjztfpvobwuhgnxvbxcptp", + "documentationReference": "kjw" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json new file mode 100644 index 000000000000..91083a21358b --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "SustainabilityService_GetFactorMapping_MaximumSet", + "operationId": "SustainabilityService_GetFactorMapping", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorMappingId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "factorMappingId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "hdiesoxsmwwgszdbabaw", + "factor": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData1": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData2": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData3": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData4": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json new file mode 100644 index 000000000000..65ac1566fcf3 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "SustainabilityService_GetReferenceEntityRecord_MaximumSet", + "operationId": "SustainabilityService_GetReferenceEntityRecord", + "parameters": { + "api-version": "2025-01-01-preview", + "entityName": "ceh", + "id": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "data": {} + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json new file mode 100644 index 000000000000..df001c444645 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SustainabilityService_ListCalculationModels_MaximumSet", + "operationId": "SustainabilityService_ListCalculationModels", + "parameters": { + "api-version": "2025-01-01-preview", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "mrgyzzhuyw", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "calculationFlowJson": "g", + "calculationMethod": "vssewtlgtulccramolznv", + "dataDefinitionId": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "xpblerxeeftidqjyvtcmilzgvhktz", + "emissionCalculationId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionSource": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "modelJsonVersion": "nr", + "name": "guftftnectufbgwipbhhecaqsiyqm", + "sustainabilitymodule": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "type": "pwrdfsnaqq" + } + ], + "nextLink": "https://microsoft.com/aemwq" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json new file mode 100644 index 000000000000..27972b6a7b9c --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "SustainabilityService_ListCalculationModels_MinimumSet", + "operationId": "SustainabilityService_ListCalculationModels", + "parameters": { + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "mrgyzzhuyw", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionCalculationId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionSource": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "guftftnectufbgwipbhhecaqsiyqm", + "type": "pwrdfsnaqq" + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json new file mode 100644 index 000000000000..262a57425d13 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json @@ -0,0 +1,114 @@ +{ + "title": "SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet", + "operationId": "SustainabilityService_ListEmissionFactorsByFactorLibrary", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "mhysdemejmnlrixkibxbdpulaclivw", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "ch4": 15, + "ch4Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2": 12, + "co2Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2e": 1, + "co2eUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "tjvhdxkfzubx", + "emissionFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "hfcs": 11, + "hfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "isBiofuel": true, + "name": "jprosbghrgieuoltgmecmdysjj", + "nf3": 22, + "nf3Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "n2o": 12, + "n2oUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "otherGhgs": 25, + "otherGhgsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "pfcs": 24, + "pfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "sf6": 8, + "sf6Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "subtype": "oaslhlpcquf", + "type": "wtihrlbbaftknflb", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + ], + "nextLink": "https://microsoft.com/alvec" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json new file mode 100644 index 000000000000..d5c5121decef --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet", + "operationId": "SustainabilityService_ListEstimationFactorsByFactorLibrary", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "dxp", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "documentationReference": "mpzznkdybhkf", + "estimationFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "factorValue": 19, + "factorValueUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "yribs", + "subtype": "opuhkswrndvdihbnxj", + "type": "oaijjfbo", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json new file mode 100644 index 000000000000..4cc6753c6a5a --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "SustainabilityService_ListFactorLibraries_MaximumSet", + "operationId": "SustainabilityService_ListFactorLibraries", + "parameters": { + "api-version": "2025-01-01-preview", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "name": "xxjsatedcocthjfjzzkuhxk", + "libraryType": "eklvmkzxqance", + "attribution": "gortdjkgmtn", + "version": "zplrzyy", + "description": "cfrtht", + "datePublished": "qeumvdzjztfpvobwuhgnxvbxcptp", + "documentationReference": "kjw" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json new file mode 100644 index 000000000000..d2d09f17d3a8 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SustainabilityService_ListFactorLibraries_MinimumSet", + "operationId": "SustainabilityService_ListFactorLibraries", + "parameters": { + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "name": "xxjsatedcocthjfjzzkuhxk", + "libraryType": "eklvmkzxqance" + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json new file mode 100644 index 000000000000..151133667273 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "SustainabilityService_ListFactorMappings_MaximumSet", + "operationId": "SustainabilityService_ListFactorMappings", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "factorMappingId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "hdiesoxsmwwgszdbabaw", + "factor": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData1": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData2": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData3": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData4": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + ], + "nextLink": "https://microsoft.com/ayj" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a26af519765 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "SustainabilityService_ListReferenceEntitiesMaximumSet_Gen", + "operationId": "SustainabilityService_ListReferenceEntities", + "parameters": { + "api-version": "2025-01-01-preview", + "maxpagesize": 15 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "amyedfjgzjwxyuwseqdtpachjik", + "displayName": "caplosquafmtpbxpykxxi", + "schemaName": "fxlpjbeznsiuazo" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json new file mode 100644 index 000000000000..38813f8711d7 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SustainabilityService_ListReferenceEntities_MinimumSet_Gen", + "operationId": "SustainabilityService_ListReferenceEntities", + "parameters": { + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "amyedfjgzjwxyuwseqdtpachjik", + "displayName": "caplosquafmtpbxpykxxi", + "schemaName": "fxlpjbeznsiuazo" + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json new file mode 100644 index 000000000000..dbcfea6031db --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "SustainabilityService_ListReferenceEntityRecords_MaximumSet", + "operationId": "SustainabilityService_ListReferenceEntityRecords", + "parameters": { + "api-version": "2025-01-01-preview", + "entityName": "hiahquzdipmrxufnjgbfh", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "data": {} + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json new file mode 100644 index 000000000000..75190f4aa14f --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/examples/2025-01-01-preview/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SustainabilityService_ListReferenceEntityRecords_MinimumSet", + "operationId": "SustainabilityService_ListReferenceEntityRecords", + "parameters": { + "api-version": "2025-01-01-preview", + "entityName": "jl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "data": {} + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/main.tsp b/specification/sustainabilityservices/Microsoft.SustainabilityServices/main.tsp new file mode 100644 index 000000000000..6e191ba05404 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/main.tsp @@ -0,0 +1,40 @@ +import "@typespec/http"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-autorest"; +import "./routes.tsp"; +import "./models/emissioncalculation.tsp"; +import "./models/factorlibrary.tsp"; +import "./models/referencedata.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; + +@useAuth( + OAuth2Auth<[ + { + type: OAuth2FlowType.clientCredentials, + tokenUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/token", + } + ]> +) +@service(#{ title: "Microsoft.SustainabilityServices" }) +@versioned(Versions) +@server( + "{endpoint}", + "These APIs allow end users to run the calculate the carbon emissions for the activities.", + { + endpoint: url, + } +) +@versioned(Microsoft.SustainabilityServices.Versions) +namespace Microsoft.SustainabilityServices; + +@doc("Supported API versions for the Microsoft.SustainabilityServices.") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @doc("The 2025-01-01-preview version of the Microsoft.SustainabilityServices.") + v2025_01_01_preview: "2025-01-01-preview", +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/emissioncalculation.tsp b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/emissioncalculation.tsp new file mode 100644 index 000000000000..fc99051f283c --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/emissioncalculation.tsp @@ -0,0 +1,217 @@ +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-autorest"; +import "./othermodels.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; + +namespace Microsoft.SustainabilityServices; + +@doc("Calculation request.") +model EmissionCalculationRequest { + @doc("Time stamp.") + timeStamp?: utcDateTime; + + @doc("Calculation model id to be used. Use listCalculationModels API to get the list of all calculation models and choose the appropriate model based on the usecase.") + calculationModelId: uuid; + + @doc("Assessment report version to be used in the calculation. If no arVersion is specified in the payload, AR4 version is the default version") + arVersion?: ArVersions = ArVersions.AR4; + + @doc("List of activities on which the calculation is to be performed.") + activities: EmissionActivity[]; +} + +@doc("The output of a calculation.") +model EmissionCalculationResult { + @doc("Calculation summary.") + summary: CalculationSummary; + + @doc("Calculation error details.") + errorDetails: CalculationErrorDetails[]; + + @doc("Calculated emissions from the activities.") + activityEmissionOutput: ActivityEmissionOutput[]; +} + +@doc("Logical representation of the emission calculation that runs the calculation methodology bringing activity data and emission factors together.") +@resource("calculation-models") +model CalculationModel { + @doc("Entity name.") + entityName: string; + + @doc("Calculation model ID.") + @key("calculationModelId") + @visibility(Lifecycle.Read) + calculationModelId: uuid; + + @doc("Calculation flow json.") + calculationFlowJson?: string; + + @doc("Calculation method or model used to calculate emissions, as recommended by protocol.") + calculationMethod?: string; + + @doc("Data definition of source.") + dataDefinitionId?: LookupField; + + @doc("Document reference.") + documentationReference?: string; + + @doc("Emission calculation ID.") + emissionCalculationId: uuid; + + @doc("Emission source.") + emissionSource: LookupField; + + @doc("Model JSON version.") + modelJsonVersion?: string; + + @doc("Calculation model name.") + name: string; + + @doc("Sustainability module.") + sustainabilitymodule?: LookupField; + + @doc("Model type.") + type: string; +} + +@doc("Describes the summary of the calculation.") +model CalculationSummary { + @doc("Calculation status.") + status: CalculationStatusEnum; + + @doc("Total number of successful activities.") + successfulActivities: int64; + + @doc("Total number of failed activities.") + failedActivities: int64; + + @doc("Total number of excluded activities.") + excludedActivities: int64; + + @doc("Total number of processed activities.") + processedActivities: int64; +} + +@doc("Output emission of the activity") +model ActivityEmissionOutput { + @doc("Activity ID.") + id: EmissionActivity.id; + + @doc("Activity emissions for the activity.") + emissions: GhgEmissions[]; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" +@doc("Activity.") +@resource("activities") +model EmissionActivity { + @minLength(1) + @doc("Activity ID.") + @key("id") + @visibility(Lifecycle.Read, Lifecycle.Create) + id: uuid; + + @doc("Activity data.") + activityData: Record; +} + +@doc("Emissions for the activity.") +model GhgEmissions { + @doc("CH4 emission.") + ch4?: float32; + + @doc("CH4 emissions unit.") + ch4Unit?: string; + + @doc("CO2 emissions.") + co2?: float32; + + @doc("CO2 emissions unit.") + co2Unit?: string; + + @doc("CO2e emissions.") + co2e?: float32; + + @doc("CO2e emissions unit.") + co2eUnit?: string; + + @doc("CO2emt emissions.") + co2emt?: float32; + + @doc("HFCs emissions.") + hfcs?: float32; + + @doc("HFCs emissions unit.") + hfcsUnit?: string; + + @doc("N2O emissions.") + n2o?: float32; + + @doc("N2O emissions unit.") + n2oUnit?: string; + + @doc("NF3 emissions.") + nf3?: float32; + + @doc("NF3 emissions unit.") + nf3Unit?: string; + + @doc("PFCs emissions.") + pfcs?: float32; + + @doc("PFCs emissions unit.") + pfcsUnit?: string; + + @doc("Other GHG emissions.") + otherGhgs?: float32; + + @doc("Other GHG emissions unit.") + otherGhgsUnit?: string; + + @doc("SF6 emissions.") + sf6?: float32; + + @doc("SF6 emissions unit.") + sf6Unit?: string; + + @doc("Is market based.") + isMarketBased?: boolean; + + @doc("Is biogenic.") + isBiogenic?: boolean; + + @doc("Emission calculation model used for the calculation.") + emissionCalculationModel?: string; + + @doc("Factor library used for the calculation.") + calculationLibrary?: string; + + @doc("Emission factor used for the calculation.") + emissionFactor?: string; + + @doc("Actual quantity of the activity responsible for the emission. For example, the actual quantity for a business trip involving a hotel stay might be the number of nights stayed multiplied by the estimation factor.") + adjustedActualQuantity?: string; + + @doc("Actual quantity unit.") + adjustedActualQuantityUnit?: string; +} + +@error +@doc("Details of the error in calculation") +model CalculationErrorDetails { + @doc("Activity ID.") + activityId: EmissionActivity.id; + + @doc("Activity name.") + activityName: string; + + @doc("Error message.") + message: string; + + @doc("Error code.") + code: string; +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/factorlibrary.tsp b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/factorlibrary.tsp new file mode 100644 index 000000000000..ca86692288c4 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/factorlibrary.tsp @@ -0,0 +1,202 @@ +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-autorest"; +import "./othermodels.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; + +namespace Microsoft.SustainabilityServices; + +@resource("factor-libraries") +@doc("Represents collection of emission and estimation factors.") +model FactorLibrary { + @key("factorLibraryId") + @doc("Factor library id.") + @visibility(Lifecycle.Read) + factorLibraryId: uuid; + + @doc("Factor library name.") + name: string; + + @doc("Type of factor library: estimation or emission.") + libraryType: string; + + @doc("Appropriate acknowledgment to the original content creator when utilizing or distributing their work within the application.") + attribution?: string; + + @doc("Factor library version.") + version?: string; + + @doc("Description of the library.") + description?: string; + + @doc("Date published.") + datePublished?: string; + + @doc("Documentation reference.") + documentationReference?: string; +} + +@doc("Estimation factors are used to convert proxy data into activity data that can be used with an emission factor. Typical examples are square footage of real estate to convert to energy or refrigerants, and the number of nights of a hotel stay") +@resource("estimation-factors") +@parentResource(FactorLibrary) +model EstimationFactor { + @doc("Entity name.") + entityName: string; + + @doc("ID.") + id: uuid; + + @doc("Document reference.") + documentationReference?: string; + + @doc("Estimation factor ID.") + @key + @visibility(Lifecycle.Read) + estimationFactorId: uuid; + + @doc("Factor library which the estimation factor belongs to.") + factorLibrary: LookupField; + + @doc("Estimation factor value.") + factorValue: float64; + + @doc("Unit for factor value.") + factorValueUnit: LookupField; + + @doc("Estimation factor name.") + name: string; + + @doc("Subtype.") + subtype?: string; + + @doc("Type.") + type?: string; + + @doc("Unit.") + unit: LookupField; +} + +@doc("Conversion factor to convert quantities in activity data into greenhouse gas emissions.") +@resource("emission-factors") +@parentResource(FactorLibrary) +model EmissionFactor { + @doc("Entity name.") + entityName: string; + + @doc("Factor library to which the emission factor belongs to.") + factorLibrary: LookupField; + + @doc("CH4 factor value.") + ch4?: float64; + + @doc("Unit for CH4 factor value.") + ch4Unit?: LookupField; + + @doc("CO2 factor value.") + co2?: float64; + + @doc("Unit for CO2 factor value.") + co2Unit?: LookupField; + + @doc("CO2e factor value.") + co2e?: float64; + + @doc("Unit for CO2e factor value.") + co2eUnit?: LookupField; + + @doc("Documentation reference.") + documentationReference?: string; + + @doc("Emission factor ID.") + @key("emissionFactorId") + @visibility(Lifecycle.Read) + emissionFactorId: uuid; + + @doc("ID.") + id: uuid; + + @doc("HFCs factor value.") + hfcs?: float64; + + @doc("Unit for HFCs factor value.") + hfcsUnit?: LookupField; + + @doc("Is biofuel.") + isBiofuel?: boolean; + + @doc("Emission factor name.") + name: string; + + @doc("NF3 factor value.") + nf3?: float64; + + @doc("Unit for NF3 factor value.") + nf3Unit?: LookupField; + + @doc("NO2 factor value.") + n2o?: float64; + + @doc("Unit for N2O factor value.") + n2oUnit?: LookupField; + + @doc("Other GHG factor value.") + otherGhgs?: float64; + + @doc("Unit for other GHGs factor value.") + otherGhgsUnit?: LookupField; + + @doc("PFCs factor value.") + pfcs?: float64; + + @doc("Unit for PFCs factor value.") + pfcsUnit?: LookupField; + + @doc("SF6 factor value.") + sf6?: float64; + + @doc("Unit for SF6 factor value.") + sf6Unit?: LookupField; + + @doc("Subtype.") + subtype?: string; + + @doc("Type.") + type?: string; + + @doc("Unit.") + unit?: LookupField; +} + +@doc("Factor mapping.") +@resource("factor-mappings") +@parentResource(FactorLibrary) +model FactorMapping { + @key("factorMappingId") + @visibility(Lifecycle.Read) + @doc("Factor mapping id.") + factorMappingId: uuid; + + @doc("Factor library which this mapping belongs to.") + factorLibrary: LookupField; + + @doc("Name.") + name: string; + + @doc("Factor associated with the factor mapping.") + factor: LookupField; + + @doc("Reference data 1") + referenceData1: LookupField; + + @doc("Reference data 2") + referenceData2?: LookupField; + + @doc("Reference data 3") + referenceData3?: LookupField; + + @doc("Reference data 4") + referenceData4?: LookupField; +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/othermodels.tsp b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/othermodels.tsp new file mode 100644 index 000000000000..ee0ebd521b3b --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/othermodels.tsp @@ -0,0 +1,72 @@ +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-autorest"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; + +namespace Microsoft.SustainabilityServices; + +@doc("Response headers.") +model ResponseHeaders { + @doc("Correlation id.") + @header("correlation-id") + correlationId: uuid; + + @doc("List of api supported versions.") + @header("api-supported-versions") + apiSupportedVersions?: Versions[]; + + ...RequestIdResponseHeader; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" +@doc("Lookup details.") +model LookupField { + @doc("Unique ID of the referenced field value.") + id: uuid; + + @doc("Schema name of the referenced table.") + logicalName: string; + + @doc("Display name of the referenced field value.") + name: string; + + @doc("Key attributes of the referenced field.") + keyAttributes: Record; + + @doc("Row version.") + rowVersion: string; +} + +@doc("Assessment report version to be used in the calculation.") +union ArVersions { + @doc("Custom.") + Custom: "Custom", + + @doc("AR4 version.") + AR4: "AR4", + + @doc("AR5 version.") + AR5: "AR5", + + @doc("AR6 version.") + AR6: "AR6", + + string, +} + +@doc("Calculation status.") +union CalculationStatusEnum { + @doc("Succeeded.") + Succeeded: "Succeeded", + + @doc("Failed.") + Failed: "Failed", + + @doc("Calculation completed with errors.") + CompletedWithErrors: "CompletedWithErrors", + + string, +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/referencedata.tsp b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/referencedata.tsp new file mode 100644 index 000000000000..8ac22d1aaf18 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/models/referencedata.tsp @@ -0,0 +1,39 @@ +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-autorest"; +import "./othermodels.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; + +namespace Microsoft.SustainabilityServices; + +@doc("Reference data.") +@resource("reference-data") +model ReferenceDataEntities { + @doc("Logical name of the entity. Example: fueltype.") + @key + @visibility(Lifecycle.Read) + entityName: string; + + @doc("Display name of the entity. Example: Fuel Type.") + displayName: string; + + @doc("Schema name of the entity.") + schemaName: string; +} + +#suppress "@azure-tools/typespec-azure-core/bad-record-type" +@doc("Entity record.") +@parentResource(ReferenceDataEntities) +@resource("entity-records") +model EntityRecord { + @doc("Record ID.") + @key + @visibility(Lifecycle.Read) + id: uuid; + + @doc("Entity data.") + data: Record; +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/routes.tsp b/specification/sustainabilityservices/Microsoft.SustainabilityServices/routes.tsp new file mode 100644 index 000000000000..6987ae84ee24 --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/routes.tsp @@ -0,0 +1,92 @@ +import "@typespec/http"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-autorest"; +import "./models/factorlibrary.tsp"; +import "./models/emissioncalculation.tsp"; +import "./models/referencedata.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core.Traits; +using Azure.Core; + +namespace Microsoft.SustainabilityServices; + +alias ServiceTraits = NoRepeatableRequests & + NoConditionalRequests & + NoClientRequestId & + ResponseHeadersTrait; + +alias Operations = Azure.Core.ResourceOperations; + +@route("sustainability") +interface SustainabilityService { + @doc("Lists factor libraries.") + listFactorLibraries is Operations.ResourceList< + FactorLibrary, + ListQueryParametersTrait + >; + + @doc("Gets factor library by id.") + getFactorLibrary is Operations.ResourceRead; + + @doc("Lists estimation factors within the given factor library id.") + listEstimationFactorsByFactorLibrary is Operations.ResourceList< + EstimationFactor, + ListQueryParametersTrait + >; + + @doc("Gets estimation factor by id.") + getEstimationFactor is Operations.ResourceRead; + + @doc("Lists emission factors within the given factor library id.") + listEmissionFactorsByFactorLibrary is Operations.ResourceList< + EmissionFactor, + ListQueryParametersTrait + >; + + @doc("Gets emission factor by id.") + getEmissionFactor is Operations.ResourceRead; + + @doc("Lists factor mappings belonging to the factor library.") + listFactorMappings is Operations.ResourceList< + FactorMapping, + ListQueryParametersTrait + >; + + @doc("Gets factor mapping by id.") + getFactorMapping is Operations.ResourceRead; + + @doc("Lists calculation models for the given activity source.") + listCalculationModels is Operations.ResourceList< + CalculationModel, + ListQueryParametersTrait + >; + + @doc("Gets calculation model by id.") + getCalculationModel is Operations.ResourceRead; + + @doc("Lists reference data entities.") + listReferenceEntities is Operations.ResourceList< + ReferenceDataEntities, + ListQueryParametersTrait + >; + + @doc("Fetch records of the given reference data entity.") + listReferenceEntityRecords is Operations.ResourceList< + EntityRecord, + ListQueryParametersTrait + >; + + @doc("Gets reference data entity record by id.") + getReferenceEntityRecord is Operations.ResourceRead; + + @doc("Calculate emissions.") + calculateEmissions is Operations.ResourceCollectionAction< + EmissionActivity, + EmissionCalculationRequest, + EmissionCalculationResult + >; +} diff --git a/specification/sustainabilityservices/Microsoft.SustainabilityServices/tspconfig.yaml b/specification/sustainabilityservices/Microsoft.SustainabilityServices/tspconfig.yaml new file mode 100644 index 000000000000..dc49c3f2615e --- /dev/null +++ b/specification/sustainabilityservices/Microsoft.SustainabilityServices/tspconfig.yaml @@ -0,0 +1,40 @@ +parameters: + "service-dir": + default: "sdk/sustainabilityservices" + "dependencies": + "additionalDirectories": [] + default: "" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "data-plane" + emitter-output-dir: "{project-root}/.." + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" + "@azure-tools/typespec-python": + flavor: azure + package-dir: "azure-sustainabilityservices" + package-name: "{package-dir}" + package-mode: dataplane + generateTest: true + generateSample: true + "@azure-tools/typespec-csharp": + flavor: azure + package-dir: "Azure.SustainabilityServices" + namespace: "{package-dir}" + clear-output-folder: true + model-namespace: false + "@azure-tools/typespec-ts": + flavor: azure + package-dir: "sustainabilityservices-rest" + generateMetadata: true + generateTest: true + packageDetails: + name: "@azure-rest/sustainabilityservices-rest" + "@azure-tools/typespec-java": + flavor: azure + package-dir: "azure-sustainabilityservices" + namespace: com.azure.sustainabilityservices +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/sustainabilityservices/cspell.yaml b/specification/sustainabilityservices/cspell.yaml new file mode 100644 index 000000000000..15b6bb4b9302 --- /dev/null +++ b/specification/sustainabilityservices/cspell.yaml @@ -0,0 +1,12 @@ +# This file configures spell checking. Items in "words" were initially populated +# with words that might be spelling errors. Review these words and take +# appropriate action. For more information, see: https://aka.ms/ci-fix#spell-check + +# Spell checking is not case sensitive +# Keep word lists in alphabetical order so the file is easier to manage +import: + - ../../cspell.yaml +words: + - hfcs + - pfcs + - Ghgs diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json new file mode 100644 index 000000000000..ef580b9d3f9e --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "SustainabilityService_CalculateEmissions_MaximumSet", + "operationId": "SustainabilityService_CalculateEmissions", + "parameters": { + "api-version": "2025-01-01-preview", + "body": { + "timeStamp": "2025-03-05T07:25:40.609Z", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "arVersion": "Custom", + "activities": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityData": {} + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "status": "Succeeded", + "successfulActivities": 6, + "failedActivities": 12, + "excludedActivities": 1, + "processedActivities": 9 + }, + "errorDetails": [ + { + "activityId": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityName": "agxovdvljfxgsxvtyf", + "message": "wgyz", + "code": "liryrrxbbgxkavfmjfcwjtrjluqg" + } + ], + "activityEmissionOutput": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissions": [ + { + "ch4": 9, + "ch4Unit": "tbdfmm", + "co2": 17, + "co2Unit": "gnxxtgszgon", + "co2e": 5, + "co2eUnit": "owepcjpaoxlmkpstpofkcjwg", + "co2emt": 27, + "hfcs": 17, + "hfcsUnit": "lrnesztablxhxymmusywxswgpxpx", + "n2o": 11, + "n2oUnit": "fczxflvwikmymdfttjfwhvenwz", + "nf3": 1, + "nf3Unit": "xctbgnnxeqiijmjmsocfvqxds", + "pfcs": 5, + "pfcsUnit": "vbdvqpbxrxovj", + "otherGhgs": 1, + "otherGhgsUnit": "nnghkaxryvazxcnkfgqikrggwfzb", + "sf6": 11, + "sf6Unit": "djgebfbyzjgfxslhhmvipd", + "isMarketBased": true, + "isBiogenic": true, + "emissionCalculationModel": "rf", + "calculationLibrary": "xcoypozdrjrgqyyrfotonpkobua", + "emissionFactor": "shfuzrdkggeabfwxpj", + "adjustedActualQuantity": "nmeqfk", + "adjustedActualQuantityUnit": "wpcobpvcffibmmmvrqwolvdpgoijl" + } + ] + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json new file mode 100644 index 000000000000..747996b22cb3 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "SustainabilityService_CalculateEmissions_MinimumSet", + "operationId": "SustainabilityService_CalculateEmissions", + "parameters": { + "api-version": "2025-01-01-preview", + "body": { + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "activities": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityData": {} + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "status": "Succeeded", + "successfulActivities": 6, + "failedActivities": 12, + "excludedActivities": 1, + "processedActivities": 9 + }, + "errorDetails": [ + { + "activityId": "b7baa418-08be-430b-ae46-769cfdf91949", + "activityName": "agxovdvljfxgsxvtyf", + "message": "wgyz", + "code": "liryrrxbbgxkavfmjfcwjtrjluqg" + } + ], + "activityEmissionOutput": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissions": [ + {} + ] + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json new file mode 100644 index 000000000000..e1c13e4baaf9 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "SustainabilityService_GetCalculationModel_MaximumSet", + "operationId": "SustainabilityService_GetCalculationModel", + "parameters": { + "api-version": "2025-01-01-preview", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "entityName": "mrgyzzhuyw", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "calculationFlowJson": "g", + "calculationMethod": "vssewtlgtulccramolznv", + "dataDefinitionId": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "xpblerxeeftidqjyvtcmilzgvhktz", + "emissionCalculationId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionSource": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "modelJsonVersion": "nr", + "name": "guftftnectufbgwipbhhecaqsiyqm", + "sustainabilitymodule": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "type": "pwrdfsnaqq" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dff8ef87bf9 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json @@ -0,0 +1,109 @@ +{ + "title": "SustainabilityService_GetEmissionFactor_MaximumSet", + "operationId": "SustainabilityService_GetEmissionFactor", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionFactorId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "entityName": "mhysdemejmnlrixkibxbdpulaclivw", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "ch4": 15, + "ch4Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2": 12, + "co2Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2e": 1, + "co2eUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "tjvhdxkfzubx", + "emissionFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "hfcs": 11, + "hfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "isBiofuel": true, + "name": "jprosbghrgieuoltgmecmdysjj", + "nf3": 22, + "nf3Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "n2o": 12, + "n2oUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "otherGhgs": 25, + "otherGhgsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "pfcs": 24, + "pfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "sf6": 8, + "sf6Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "subtype": "oaslhlpcquf", + "type": "wtihrlbbaftknflb", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json new file mode 100644 index 000000000000..494768741dba --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "SustainabilityService_GetEstimationFactor_MaximumSet", + "operationId": "SustainabilityService_GetEstimationFactor", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "estimationFactorId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "entityName": "dxp", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "documentationReference": "mpzznkdybhkf", + "estimationFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "factorValue": 19, + "factorValueUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "yribs", + "subtype": "opuhkswrndvdihbnxj", + "type": "oaijjfbo", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json new file mode 100644 index 000000000000..697cbfa0e529 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "SustainabilityService_GetFactorLibrary_MaximumSet", + "operationId": "SustainabilityService_GetFactorLibrary", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "name": "xxjsatedcocthjfjzzkuhxk", + "libraryType": "eklvmkzxqance", + "attribution": "gortdjkgmtn", + "version": "zplrzyy", + "description": "cfrtht", + "datePublished": "qeumvdzjztfpvobwuhgnxvbxcptp", + "documentationReference": "kjw" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json new file mode 100644 index 000000000000..91083a21358b --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "SustainabilityService_GetFactorMapping_MaximumSet", + "operationId": "SustainabilityService_GetFactorMapping", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorMappingId": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "factorMappingId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "hdiesoxsmwwgszdbabaw", + "factor": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData1": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData2": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData3": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData4": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json new file mode 100644 index 000000000000..65ac1566fcf3 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "title": "SustainabilityService_GetReferenceEntityRecord_MaximumSet", + "operationId": "SustainabilityService_GetReferenceEntityRecord", + "parameters": { + "api-version": "2025-01-01-preview", + "entityName": "ceh", + "id": "b7baa418-08be-430b-ae46-769cfdf91949" + }, + "responses": { + "200": { + "body": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "data": {} + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json new file mode 100644 index 000000000000..df001c444645 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SustainabilityService_ListCalculationModels_MaximumSet", + "operationId": "SustainabilityService_ListCalculationModels", + "parameters": { + "api-version": "2025-01-01-preview", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "mrgyzzhuyw", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "calculationFlowJson": "g", + "calculationMethod": "vssewtlgtulccramolznv", + "dataDefinitionId": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "xpblerxeeftidqjyvtcmilzgvhktz", + "emissionCalculationId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionSource": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "modelJsonVersion": "nr", + "name": "guftftnectufbgwipbhhecaqsiyqm", + "sustainabilitymodule": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "type": "pwrdfsnaqq" + } + ], + "nextLink": "https://microsoft.com/aemwq" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json new file mode 100644 index 000000000000..27972b6a7b9c --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "title": "SustainabilityService_ListCalculationModels_MinimumSet", + "operationId": "SustainabilityService_ListCalculationModels", + "parameters": { + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "mrgyzzhuyw", + "calculationModelId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionCalculationId": "b7baa418-08be-430b-ae46-769cfdf91949", + "emissionSource": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "guftftnectufbgwipbhhecaqsiyqm", + "type": "pwrdfsnaqq" + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json new file mode 100644 index 000000000000..262a57425d13 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json @@ -0,0 +1,114 @@ +{ + "title": "SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet", + "operationId": "SustainabilityService_ListEmissionFactorsByFactorLibrary", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "mhysdemejmnlrixkibxbdpulaclivw", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "ch4": 15, + "ch4Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2": 12, + "co2Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "co2e": 1, + "co2eUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "documentationReference": "tjvhdxkfzubx", + "emissionFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "hfcs": 11, + "hfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "isBiofuel": true, + "name": "jprosbghrgieuoltgmecmdysjj", + "nf3": 22, + "nf3Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "n2o": 12, + "n2oUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "otherGhgs": 25, + "otherGhgsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "pfcs": 24, + "pfcsUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "sf6": 8, + "sf6Unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "subtype": "oaslhlpcquf", + "type": "wtihrlbbaftknflb", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + ], + "nextLink": "https://microsoft.com/alvec" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json new file mode 100644 index 000000000000..d5c5121decef --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet", + "operationId": "SustainabilityService_ListEstimationFactorsByFactorLibrary", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "dxp", + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "documentationReference": "mpzznkdybhkf", + "estimationFactorId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "factorValue": 19, + "factorValueUnit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "yribs", + "subtype": "opuhkswrndvdihbnxj", + "type": "oaijjfbo", + "unit": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json new file mode 100644 index 000000000000..4cc6753c6a5a --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "title": "SustainabilityService_ListFactorLibraries_MaximumSet", + "operationId": "SustainabilityService_ListFactorLibraries", + "parameters": { + "api-version": "2025-01-01-preview", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "name": "xxjsatedcocthjfjzzkuhxk", + "libraryType": "eklvmkzxqance", + "attribution": "gortdjkgmtn", + "version": "zplrzyy", + "description": "cfrtht", + "datePublished": "qeumvdzjztfpvobwuhgnxvbxcptp", + "documentationReference": "kjw" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json new file mode 100644 index 000000000000..d2d09f17d3a8 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SustainabilityService_ListFactorLibraries_MinimumSet", + "operationId": "SustainabilityService_ListFactorLibraries", + "parameters": { + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "name": "xxjsatedcocthjfjzzkuhxk", + "libraryType": "eklvmkzxqance" + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json new file mode 100644 index 000000000000..151133667273 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "title": "SustainabilityService_ListFactorMappings_MaximumSet", + "operationId": "SustainabilityService_ListFactorMappings", + "parameters": { + "api-version": "2025-01-01-preview", + "factorLibraryId": "b7baa418-08be-430b-ae46-769cfdf91949", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "factorMappingId": "b7baa418-08be-430b-ae46-769cfdf91949", + "factorLibrary": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "name": "hdiesoxsmwwgszdbabaw", + "factor": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData1": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData2": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData3": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + }, + "referenceData4": { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "logicalName": "pbmfspnnuunedveu", + "name": "qggwqivyfidlfquwibds", + "keyAttributes": {}, + "rowVersion": "mjopupgolatxymbilffp" + } + } + ], + "nextLink": "https://microsoft.com/ayj" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a26af519765 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "SustainabilityService_ListReferenceEntitiesMaximumSet_Gen", + "operationId": "SustainabilityService_ListReferenceEntities", + "parameters": { + "api-version": "2025-01-01-preview", + "maxpagesize": 15 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "amyedfjgzjwxyuwseqdtpachjik", + "displayName": "caplosquafmtpbxpykxxi", + "schemaName": "fxlpjbeznsiuazo" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json new file mode 100644 index 000000000000..38813f8711d7 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SustainabilityService_ListReferenceEntities_MinimumSet_Gen", + "operationId": "SustainabilityService_ListReferenceEntities", + "parameters": { + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "entityName": "amyedfjgzjwxyuwseqdtpachjik", + "displayName": "caplosquafmtpbxpykxxi", + "schemaName": "fxlpjbeznsiuazo" + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json new file mode 100644 index 000000000000..dbcfea6031db --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "title": "SustainabilityService_ListReferenceEntityRecords_MaximumSet", + "operationId": "SustainabilityService_ListReferenceEntityRecords", + "parameters": { + "api-version": "2025-01-01-preview", + "entityName": "hiahquzdipmrxufnjgbfh", + "maxpagesize": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "data": {} + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json new file mode 100644 index 000000000000..75190f4aa14f --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/examples/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "SustainabilityService_ListReferenceEntityRecords_MinimumSet", + "operationId": "SustainabilityService_ListReferenceEntityRecords", + "parameters": { + "api-version": "2025-01-01-preview", + "entityName": "jl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "b7baa418-08be-430b-ae46-769cfdf91949", + "data": {} + } + ] + } + } + } +} diff --git a/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/openapi.json b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/openapi.json new file mode 100644 index 000000000000..ff8a82dfcc84 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/Microsoft.SustainabilityServices/preview/2025-01-01-preview/openapi.json @@ -0,0 +1,2270 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.SustainabilityServices", + "version": "2025-01-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "application", + "scopes": {}, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token" + } + }, + "tags": [], + "paths": { + "/sustainability/activities:calculateEmissions": { + "post": { + "operationId": "SustainabilityService_CalculateEmissions", + "description": "Calculate emissions.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EmissionCalculationRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EmissionCalculationResult" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_CalculateEmissions_MaximumSet": { + "$ref": "./examples/SustainabilityService_CalculateEmissions_MaximumSet_Gen.json" + }, + "SustainabilityService_CalculateEmissions_MinimumSet": { + "$ref": "./examples/SustainabilityService_CalculateEmissions_MinimumSet_Gen.json" + } + } + } + }, + "/sustainability/calculation-models": { + "get": { + "operationId": "SustainabilityService_ListCalculationModels", + "description": "Lists calculation models for the given activity source.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCalculationModel" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_ListCalculationModels_MaximumSet": { + "$ref": "./examples/SustainabilityService_ListCalculationModels_MaximumSet_Gen.json" + }, + "SustainabilityService_ListCalculationModels_MinimumSet": { + "$ref": "./examples/SustainabilityService_ListCalculationModels_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sustainability/calculation-models/{calculationModelId}": { + "get": { + "operationId": "SustainabilityService_GetCalculationModel", + "description": "Gets calculation model by id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "calculationModelId", + "in": "path", + "description": "Calculation model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CalculationModel" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_GetCalculationModel_MaximumSet": { + "$ref": "./examples/SustainabilityService_GetCalculationModel_MaximumSet_Gen.json" + } + } + } + }, + "/sustainability/factor-libraries": { + "get": { + "operationId": "SustainabilityService_ListFactorLibraries", + "description": "Lists factor libraries.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedFactorLibrary" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_ListFactorLibraries_MaximumSet": { + "$ref": "./examples/SustainabilityService_ListFactorLibraries_MaximumSet_Gen.json" + }, + "SustainabilityService_ListFactorLibraries_MinimumSet": { + "$ref": "./examples/SustainabilityService_ListFactorLibraries_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sustainability/factor-libraries/{factorLibraryId}": { + "get": { + "operationId": "SustainabilityService_GetFactorLibrary", + "description": "Gets factor library by id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "factorLibraryId", + "in": "path", + "description": "Factor library id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/FactorLibrary" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_GetFactorLibrary_MaximumSet": { + "$ref": "./examples/SustainabilityService_GetFactorLibrary_MaximumSet_Gen.json" + } + } + } + }, + "/sustainability/factor-libraries/{factorLibraryId}/emission-factors": { + "get": { + "operationId": "SustainabilityService_ListEmissionFactorsByFactorLibrary", + "description": "Lists emission factors within the given factor library id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "factorLibraryId", + "in": "path", + "description": "Factor library id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEmissionFactor" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet": { + "$ref": "./examples/SustainabilityService_ListEmissionFactorsByFactorLibrary_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sustainability/factor-libraries/{factorLibraryId}/emission-factors/{emissionFactorId}": { + "get": { + "operationId": "SustainabilityService_GetEmissionFactor", + "description": "Gets emission factor by id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "factorLibraryId", + "in": "path", + "description": "Factor library id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "emissionFactorId", + "in": "path", + "description": "Emission factor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EmissionFactor" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_GetEmissionFactor_MaximumSet": { + "$ref": "./examples/SustainabilityService_GetEmissionFactor_MaximumSet_Gen.json" + } + } + } + }, + "/sustainability/factor-libraries/{factorLibraryId}/estimation-factors": { + "get": { + "operationId": "SustainabilityService_ListEstimationFactorsByFactorLibrary", + "description": "Lists estimation factors within the given factor library id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "factorLibraryId", + "in": "path", + "description": "Factor library id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEstimationFactor" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet": { + "$ref": "./examples/SustainabilityService_ListEstimationFactorsByFactorLibrary_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sustainability/factor-libraries/{factorLibraryId}/estimation-factors/{estimationFactorId}": { + "get": { + "operationId": "SustainabilityService_GetEstimationFactor", + "description": "Gets estimation factor by id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "factorLibraryId", + "in": "path", + "description": "Factor library id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "estimationFactorId", + "in": "path", + "description": "Estimation factor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EstimationFactor" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_GetEstimationFactor_MaximumSet": { + "$ref": "./examples/SustainabilityService_GetEstimationFactor_MaximumSet_Gen.json" + } + } + } + }, + "/sustainability/factor-libraries/{factorLibraryId}/factor-mappings": { + "get": { + "operationId": "SustainabilityService_ListFactorMappings", + "description": "Lists factor mappings belonging to the factor library.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "factorLibraryId", + "in": "path", + "description": "Factor library id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedFactorMapping" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_ListFactorMappings_MaximumSet": { + "$ref": "./examples/SustainabilityService_ListFactorMappings_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sustainability/factor-libraries/{factorLibraryId}/factor-mappings/{factorMappingId}": { + "get": { + "operationId": "SustainabilityService_GetFactorMapping", + "description": "Gets factor mapping by id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "factorLibraryId", + "in": "path", + "description": "Factor library id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "factorMappingId", + "in": "path", + "description": "Factor mapping id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/FactorMapping" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_GetFactorMapping_MaximumSet": { + "$ref": "./examples/SustainabilityService_GetFactorMapping_MaximumSet_Gen.json" + } + } + } + }, + "/sustainability/reference-data": { + "get": { + "operationId": "SustainabilityService_ListReferenceEntities", + "description": "Lists reference data entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedReferenceDataEntities" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_ListReferenceEntitiesMaximumSet_Gen": { + "$ref": "./examples/SustainabilityService_ListReferenceEntities_MaximumSet_Gen.json" + }, + "SustainabilityService_ListReferenceEntities_MinimumSet_Gen": { + "$ref": "./examples/SustainabilityService_ListReferenceEntities_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sustainability/reference-data/{entityName}/entity-records": { + "get": { + "operationId": "SustainabilityService_ListReferenceEntityRecords", + "description": "Fetch records of the given reference data entity.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "entityName", + "in": "path", + "description": "Logical name of the entity. Example: fueltype.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEntityRecord" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_ListReferenceEntityRecords_MaximumSet": { + "$ref": "./examples/SustainabilityService_ListReferenceEntityRecords_MaximumSet_Gen.json" + }, + "SustainabilityService_ListReferenceEntityRecords_MinimumSet": { + "$ref": "./examples/SustainabilityService_ListReferenceEntityRecords_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sustainability/reference-data/{entityName}/entity-records/{id}": { + "get": { + "operationId": "SustainabilityService_GetReferenceEntityRecord", + "description": "Gets reference data entity record by id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "entityName", + "in": "path", + "description": "Logical name of the entity. Example: fueltype.", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Record ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EntityRecord" + }, + "headers": { + "api-supported-versions": { + "type": "array", + "description": "List of api supported versions.", + "items": { + "type": "string", + "enum": [ + "2025-01-01-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2025_01_01_preview", + "value": "2025-01-01-preview", + "description": "The 2025-01-01-preview version of the Microsoft.SustainabilityServices." + } + ] + } + }, + "collectionFormat": "csv" + }, + "correlation-id": { + "type": "string", + "format": "uuid", + "description": "Correlation id." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SustainabilityService_GetReferenceEntityRecord_MaximumSet": { + "$ref": "./examples/SustainabilityService_GetReferenceEntityRecord_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ActivityEmissionOutput": { + "type": "object", + "description": "Output emission of the activity", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Activity ID.", + "minLength": 1 + }, + "emissions": { + "type": "array", + "description": "Activity emissions for the activity.", + "items": { + "$ref": "#/definitions/GhgEmissions" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "id", + "emissions" + ] + }, + "ArVersions": { + "type": "string", + "description": "Assessment report version to be used in the calculation.", + "enum": [ + "Custom", + "AR4", + "AR5", + "AR6" + ], + "x-ms-enum": { + "name": "ArVersions", + "modelAsString": true, + "values": [ + { + "name": "Custom", + "value": "Custom", + "description": "Custom." + }, + { + "name": "AR4", + "value": "AR4", + "description": "AR4 version." + }, + { + "name": "AR5", + "value": "AR5", + "description": "AR5 version." + }, + { + "name": "AR6", + "value": "AR6", + "description": "AR6 version." + } + ] + } + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CalculationErrorDetails": { + "type": "object", + "description": "Details of the error in calculation", + "properties": { + "activityId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Activity ID.", + "minLength": 1 + }, + "activityName": { + "type": "string", + "description": "Activity name." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "code": { + "type": "string", + "description": "Error code." + } + }, + "required": [ + "activityId", + "activityName", + "message", + "code" + ] + }, + "CalculationModel": { + "type": "object", + "description": "Logical representation of the emission calculation that runs the calculation methodology bringing activity data and emission factors together.", + "properties": { + "entityName": { + "type": "string", + "description": "Entity name." + }, + "calculationModelId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Calculation model ID.", + "readOnly": true + }, + "calculationFlowJson": { + "type": "string", + "description": "Calculation flow json." + }, + "calculationMethod": { + "type": "string", + "description": "Calculation method or model used to calculate emissions, as recommended by protocol." + }, + "dataDefinitionId": { + "$ref": "#/definitions/LookupField", + "description": "Data definition of source." + }, + "documentationReference": { + "type": "string", + "description": "Document reference." + }, + "emissionCalculationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Emission calculation ID." + }, + "emissionSource": { + "$ref": "#/definitions/LookupField", + "description": "Emission source." + }, + "modelJsonVersion": { + "type": "string", + "description": "Model JSON version." + }, + "name": { + "type": "string", + "description": "Calculation model name." + }, + "sustainabilitymodule": { + "$ref": "#/definitions/LookupField", + "description": "Sustainability module." + }, + "type": { + "type": "string", + "description": "Model type." + } + }, + "required": [ + "entityName", + "calculationModelId", + "emissionCalculationId", + "emissionSource", + "name", + "type" + ] + }, + "CalculationStatusEnum": { + "type": "string", + "description": "Calculation status.", + "enum": [ + "Succeeded", + "Failed", + "CompletedWithErrors" + ], + "x-ms-enum": { + "name": "CalculationStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed." + }, + { + "name": "CompletedWithErrors", + "value": "CompletedWithErrors", + "description": "Calculation completed with errors." + } + ] + } + }, + "CalculationSummary": { + "type": "object", + "description": "Describes the summary of the calculation.", + "properties": { + "status": { + "$ref": "#/definitions/CalculationStatusEnum", + "description": "Calculation status." + }, + "successfulActivities": { + "type": "integer", + "format": "int64", + "description": "Total number of successful activities." + }, + "failedActivities": { + "type": "integer", + "format": "int64", + "description": "Total number of failed activities." + }, + "excludedActivities": { + "type": "integer", + "format": "int64", + "description": "Total number of excluded activities." + }, + "processedActivities": { + "type": "integer", + "format": "int64", + "description": "Total number of processed activities." + } + }, + "required": [ + "status", + "successfulActivities", + "failedActivities", + "excludedActivities", + "processedActivities" + ] + }, + "EmissionActivity": { + "type": "object", + "description": "Activity.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Activity ID.", + "minLength": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "activityData": { + "type": "object", + "description": "Activity data.", + "additionalProperties": {} + } + }, + "required": [ + "id", + "activityData" + ] + }, + "EmissionCalculationRequest": { + "type": "object", + "description": "Calculation request.", + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "Time stamp." + }, + "calculationModelId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Calculation model id to be used. Use listCalculationModels API to get the list of all calculation models and choose the appropriate model based on the usecase." + }, + "arVersion": { + "type": "string", + "description": "Assessment report version to be used in the calculation. If no arVersion is specified in the payload, AR4 version is the default version", + "default": "AR4", + "enum": [ + "Custom", + "AR4", + "AR5", + "AR6" + ], + "x-ms-enum": { + "name": "ArVersions", + "modelAsString": true, + "values": [ + { + "name": "Custom", + "value": "Custom", + "description": "Custom." + }, + { + "name": "AR4", + "value": "AR4", + "description": "AR4 version." + }, + { + "name": "AR5", + "value": "AR5", + "description": "AR5 version." + }, + { + "name": "AR6", + "value": "AR6", + "description": "AR6 version." + } + ] + } + }, + "activities": { + "type": "array", + "description": "List of activities on which the calculation is to be performed.", + "items": { + "$ref": "#/definitions/EmissionActivity" + } + } + }, + "required": [ + "calculationModelId", + "activities" + ] + }, + "EmissionCalculationResult": { + "type": "object", + "description": "The output of a calculation.", + "properties": { + "summary": { + "$ref": "#/definitions/CalculationSummary", + "description": "Calculation summary." + }, + "errorDetails": { + "type": "array", + "description": "Calculation error details.", + "items": { + "$ref": "#/definitions/CalculationErrorDetails" + }, + "x-ms-identifiers": [] + }, + "activityEmissionOutput": { + "type": "array", + "description": "Calculated emissions from the activities.", + "items": { + "$ref": "#/definitions/ActivityEmissionOutput" + } + } + }, + "required": [ + "summary", + "errorDetails", + "activityEmissionOutput" + ] + }, + "EmissionFactor": { + "type": "object", + "description": "Conversion factor to convert quantities in activity data into greenhouse gas emissions.", + "properties": { + "entityName": { + "type": "string", + "description": "Entity name." + }, + "factorLibrary": { + "$ref": "#/definitions/LookupField", + "description": "Factor library to which the emission factor belongs to." + }, + "ch4": { + "type": "number", + "format": "double", + "description": "CH4 factor value." + }, + "ch4Unit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for CH4 factor value." + }, + "co2": { + "type": "number", + "format": "double", + "description": "CO2 factor value." + }, + "co2Unit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for CO2 factor value." + }, + "co2e": { + "type": "number", + "format": "double", + "description": "CO2e factor value." + }, + "co2eUnit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for CO2e factor value." + }, + "documentationReference": { + "type": "string", + "description": "Documentation reference." + }, + "emissionFactorId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Emission factor ID.", + "readOnly": true + }, + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "ID." + }, + "hfcs": { + "type": "number", + "format": "double", + "description": "HFCs factor value." + }, + "hfcsUnit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for HFCs factor value." + }, + "isBiofuel": { + "type": "boolean", + "description": "Is biofuel." + }, + "name": { + "type": "string", + "description": "Emission factor name." + }, + "nf3": { + "type": "number", + "format": "double", + "description": "NF3 factor value." + }, + "nf3Unit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for NF3 factor value." + }, + "n2o": { + "type": "number", + "format": "double", + "description": "NO2 factor value." + }, + "n2oUnit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for N2O factor value." + }, + "otherGhgs": { + "type": "number", + "format": "double", + "description": "Other GHG factor value." + }, + "otherGhgsUnit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for other GHGs factor value." + }, + "pfcs": { + "type": "number", + "format": "double", + "description": "PFCs factor value." + }, + "pfcsUnit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for PFCs factor value." + }, + "sf6": { + "type": "number", + "format": "double", + "description": "SF6 factor value." + }, + "sf6Unit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for SF6 factor value." + }, + "subtype": { + "type": "string", + "description": "Subtype." + }, + "type": { + "type": "string", + "description": "Type." + }, + "unit": { + "$ref": "#/definitions/LookupField", + "description": "Unit." + } + }, + "required": [ + "entityName", + "factorLibrary", + "emissionFactorId", + "id", + "name" + ] + }, + "EntityRecord": { + "type": "object", + "description": "Entity record.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Record ID.", + "readOnly": true + }, + "data": { + "type": "object", + "description": "Entity data.", + "additionalProperties": {} + } + }, + "required": [ + "id", + "data" + ] + }, + "EstimationFactor": { + "type": "object", + "description": "Estimation factors are used to convert proxy data into activity data that can be used with an emission factor. Typical examples are square footage of real estate to convert to energy or refrigerants, and the number of nights of a hotel stay", + "properties": { + "entityName": { + "type": "string", + "description": "Entity name." + }, + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "ID." + }, + "documentationReference": { + "type": "string", + "description": "Document reference." + }, + "estimationFactorId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Estimation factor ID.", + "readOnly": true + }, + "factorLibrary": { + "$ref": "#/definitions/LookupField", + "description": "Factor library which the estimation factor belongs to." + }, + "factorValue": { + "type": "number", + "format": "double", + "description": "Estimation factor value." + }, + "factorValueUnit": { + "$ref": "#/definitions/LookupField", + "description": "Unit for factor value." + }, + "name": { + "type": "string", + "description": "Estimation factor name." + }, + "subtype": { + "type": "string", + "description": "Subtype." + }, + "type": { + "type": "string", + "description": "Type." + }, + "unit": { + "$ref": "#/definitions/LookupField", + "description": "Unit." + } + }, + "required": [ + "entityName", + "id", + "estimationFactorId", + "factorLibrary", + "factorValue", + "factorValueUnit", + "name", + "unit" + ] + }, + "FactorLibrary": { + "type": "object", + "description": "Represents collection of emission and estimation factors.", + "properties": { + "factorLibraryId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Factor library id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Factor library name." + }, + "libraryType": { + "type": "string", + "description": "Type of factor library: estimation or emission." + }, + "attribution": { + "type": "string", + "description": "Appropriate acknowledgment to the original content creator when utilizing or distributing their work within the application." + }, + "version": { + "type": "string", + "description": "Factor library version." + }, + "description": { + "type": "string", + "description": "Description of the library." + }, + "datePublished": { + "type": "string", + "description": "Date published." + }, + "documentationReference": { + "type": "string", + "description": "Documentation reference." + } + }, + "required": [ + "factorLibraryId", + "name", + "libraryType" + ] + }, + "FactorMapping": { + "type": "object", + "description": "Factor mapping.", + "properties": { + "factorMappingId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Factor mapping id.", + "readOnly": true + }, + "factorLibrary": { + "$ref": "#/definitions/LookupField", + "description": "Factor library which this mapping belongs to." + }, + "name": { + "type": "string", + "description": "Name." + }, + "factor": { + "$ref": "#/definitions/LookupField", + "description": "Factor associated with the factor mapping." + }, + "referenceData1": { + "$ref": "#/definitions/LookupField", + "description": "Reference data 1" + }, + "referenceData2": { + "$ref": "#/definitions/LookupField", + "description": "Reference data 2" + }, + "referenceData3": { + "$ref": "#/definitions/LookupField", + "description": "Reference data 3" + }, + "referenceData4": { + "$ref": "#/definitions/LookupField", + "description": "Reference data 4" + } + }, + "required": [ + "factorMappingId", + "factorLibrary", + "name", + "factor", + "referenceData1" + ] + }, + "GhgEmissions": { + "type": "object", + "description": "Emissions for the activity.", + "properties": { + "ch4": { + "type": "number", + "format": "float", + "description": "CH4 emission." + }, + "ch4Unit": { + "type": "string", + "description": "CH4 emissions unit." + }, + "co2": { + "type": "number", + "format": "float", + "description": "CO2 emissions." + }, + "co2Unit": { + "type": "string", + "description": "CO2 emissions unit." + }, + "co2e": { + "type": "number", + "format": "float", + "description": "CO2e emissions." + }, + "co2eUnit": { + "type": "string", + "description": "CO2e emissions unit." + }, + "co2emt": { + "type": "number", + "format": "float", + "description": "CO2emt emissions." + }, + "hfcs": { + "type": "number", + "format": "float", + "description": "HFCs emissions." + }, + "hfcsUnit": { + "type": "string", + "description": "HFCs emissions unit." + }, + "n2o": { + "type": "number", + "format": "float", + "description": "N2O emissions." + }, + "n2oUnit": { + "type": "string", + "description": "N2O emissions unit." + }, + "nf3": { + "type": "number", + "format": "float", + "description": "NF3 emissions." + }, + "nf3Unit": { + "type": "string", + "description": "NF3 emissions unit." + }, + "pfcs": { + "type": "number", + "format": "float", + "description": "PFCs emissions." + }, + "pfcsUnit": { + "type": "string", + "description": "PFCs emissions unit." + }, + "otherGhgs": { + "type": "number", + "format": "float", + "description": "Other GHG emissions." + }, + "otherGhgsUnit": { + "type": "string", + "description": "Other GHG emissions unit." + }, + "sf6": { + "type": "number", + "format": "float", + "description": "SF6 emissions." + }, + "sf6Unit": { + "type": "string", + "description": "SF6 emissions unit." + }, + "isMarketBased": { + "type": "boolean", + "description": "Is market based." + }, + "isBiogenic": { + "type": "boolean", + "description": "Is biogenic." + }, + "emissionCalculationModel": { + "type": "string", + "description": "Emission calculation model used for the calculation." + }, + "calculationLibrary": { + "type": "string", + "description": "Factor library used for the calculation." + }, + "emissionFactor": { + "type": "string", + "description": "Emission factor used for the calculation." + }, + "adjustedActualQuantity": { + "type": "string", + "description": "Actual quantity of the activity responsible for the emission. For example, the actual quantity for a business trip involving a hotel stay might be the number of nights stayed multiplied by the estimation factor." + }, + "adjustedActualQuantityUnit": { + "type": "string", + "description": "Actual quantity unit." + } + } + }, + "LookupField": { + "type": "object", + "description": "Lookup details.", + "properties": { + "id": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Unique ID of the referenced field value." + }, + "logicalName": { + "type": "string", + "description": "Schema name of the referenced table." + }, + "name": { + "type": "string", + "description": "Display name of the referenced field value." + }, + "keyAttributes": { + "type": "object", + "description": "Key attributes of the referenced field.", + "additionalProperties": {} + }, + "rowVersion": { + "type": "string", + "description": "Row version." + } + }, + "required": [ + "id", + "logicalName", + "name", + "keyAttributes", + "rowVersion" + ] + }, + "PagedCalculationModel": { + "type": "object", + "description": "Paged collection of CalculationModel items", + "properties": { + "value": { + "type": "array", + "description": "The CalculationModel items on this page", + "items": { + "$ref": "#/definitions/CalculationModel" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEmissionFactor": { + "type": "object", + "description": "Paged collection of EmissionFactor items", + "properties": { + "value": { + "type": "array", + "description": "The EmissionFactor items on this page", + "items": { + "$ref": "#/definitions/EmissionFactor" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEntityRecord": { + "type": "object", + "description": "Paged collection of EntityRecord items", + "properties": { + "value": { + "type": "array", + "description": "The EntityRecord items on this page", + "items": { + "$ref": "#/definitions/EntityRecord" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEstimationFactor": { + "type": "object", + "description": "Paged collection of EstimationFactor items", + "properties": { + "value": { + "type": "array", + "description": "The EstimationFactor items on this page", + "items": { + "$ref": "#/definitions/EstimationFactor" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedFactorLibrary": { + "type": "object", + "description": "Paged collection of FactorLibrary items", + "properties": { + "value": { + "type": "array", + "description": "The FactorLibrary items on this page", + "items": { + "$ref": "#/definitions/FactorLibrary" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedFactorMapping": { + "type": "object", + "description": "Paged collection of FactorMapping items", + "properties": { + "value": { + "type": "array", + "description": "The FactorMapping items on this page", + "items": { + "$ref": "#/definitions/FactorMapping" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedReferenceDataEntities": { + "type": "object", + "description": "Paged collection of ReferenceDataEntities items", + "properties": { + "value": { + "type": "array", + "description": "The ReferenceDataEntities items on this page", + "items": { + "$ref": "#/definitions/ReferenceDataEntities" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ReferenceDataEntities": { + "type": "object", + "description": "Reference data.", + "properties": { + "entityName": { + "type": "string", + "description": "Logical name of the entity. Example: fueltype.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of the entity. Example: Fuel Type." + }, + "schemaName": { + "type": "string", + "description": "Schema name of the entity." + } + }, + "required": [ + "entityName", + "displayName", + "schemaName" + ] + }, + "ResponseHeaders": { + "type": "object", + "description": "Response headers." + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/sustainabilityservices/data-plane/readme.md b/specification/sustainabilityservices/data-plane/readme.md new file mode 100644 index 000000000000..a0412b175c85 --- /dev/null +++ b/specification/sustainabilityservices/data-plane/readme.md @@ -0,0 +1,50 @@ +# Project Sustainability Calculator + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Sustainability service. + +## Getting Started + +To build the SDKs for Connected Cluster API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +## Configuration + +### Basic Information + +These are the global settings for the Sustainability Services API. + +```yaml +openapi-type: data-plane +tag: package-2025-01-01-preview +``` + +### Release-2025-01-01-preview + +These settings apply only when `--tag=release-2025-01-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2025-01-01-preview' +input-file: + - Microsoft.SustainabilityServices/preview/2025-01-01-preview/openapi.json +``` + +## Code Generation + +### Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-js + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-net +```