@salesforce/lds-adapters-cdp-semantic-authoring 1.332.0-dev13 → 1.332.0-dev15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/raml/api.raml CHANGED
@@ -1305,6 +1305,120 @@ types:
1305
1305
  description: The string representation of the value to filter against.
1306
1306
  type: string
1307
1307
  required: false
1308
+ SemanticGoalDateRangeInputRepresentation:
1309
+ description: Input representation for specifying a semantic goal date range
1310
+ type: object
1311
+ properties:
1312
+ endDate:
1313
+ description: The end date of the goal date range.
1314
+ type: string
1315
+ required: false
1316
+ startDate:
1317
+ description: The start date of the goal date range.
1318
+ type: string
1319
+ required: false
1320
+ SemanticGoalDateRangeOutputRepresentation:
1321
+ description: A semantic goal date range.
1322
+ type: object
1323
+ additionalProperties: true
1324
+ properties:
1325
+ endDate:
1326
+ description: The end date of the goal date range.
1327
+ type: string
1328
+ required: false
1329
+ startDate:
1330
+ description: The start date of the goal date range.
1331
+ type: string
1332
+ required: false
1333
+ SemanticGoalInputRepresentation:
1334
+ description: Input representation for specifying a semantic goal
1335
+ type: object
1336
+ properties:
1337
+ apiName:
1338
+ description: The API name of the semantic entity.
1339
+ type: string
1340
+ required: false
1341
+ description:
1342
+ description: An optional description of the semantic entity.
1343
+ type: string
1344
+ required: false
1345
+ label:
1346
+ description: The display name of the semantic entity. Optional, if not specified will use the same as the api name but instead of “_” will use spaces.
1347
+ type: string
1348
+ required: false
1349
+ dateRange:
1350
+ description: The date range of the semantic goal.
1351
+ type: SemanticGoalDateRangeInputRepresentation
1352
+ required: false
1353
+ forecasting:
1354
+ description: The forecasting flag of the semantic goal.
1355
+ type: boolean
1356
+ required: false
1357
+ statusConditions:
1358
+ description: The Status Condition list of the semantic goal.
1359
+ type: array
1360
+ items:
1361
+ type: SemanticGoalStatusConditionInputRepresentation
1362
+ required: false
1363
+ subMetricDefinitionApiName:
1364
+ description: The API name of the semantic sub metric definition.
1365
+ type: string
1366
+ required: false
1367
+ SemanticGoalOutputRepresentation:
1368
+ description: A semantic Goal.
1369
+ type: object
1370
+ additionalProperties: true
1371
+ properties:
1372
+ apiName:
1373
+ description: The API name of the semantic entity.
1374
+ type: string
1375
+ baseModelApiName:
1376
+ description: The origin model of the semantic entity.
1377
+ type: string
1378
+ required: false
1379
+ cacheKey:
1380
+ description: The Canonical URL of the collection for caching purposes only.
1381
+ type: string
1382
+ required: false
1383
+ createdBy:
1384
+ description: The user who created the semantic entity.
1385
+ type: string
1386
+ createdDate:
1387
+ description: The date in which the semantic entity was created.
1388
+ type: string
1389
+ description:
1390
+ description: The Description of the semantic entity.
1391
+ type: string
1392
+ required: false
1393
+ id:
1394
+ description: The object ID of the semantic entity.
1395
+ type: string
1396
+ label:
1397
+ description: The display name of the semantic entity to be used in the ui.
1398
+ type: string
1399
+ required: false
1400
+ lastModifiedBy:
1401
+ description: The user who last modified the semantic entity.
1402
+ type: string
1403
+ required: false
1404
+ lastModifiedDate:
1405
+ description: The date in which the semantic entity was last modified.
1406
+ type: string
1407
+ required: false
1408
+ dateRange:
1409
+ description: The date range of the semantic goal.
1410
+ type: SemanticGoalDateRangeOutputRepresentation
1411
+ forecasting:
1412
+ description: The forecasting state of the semantic goal.
1413
+ type: boolean
1414
+ statusConditions:
1415
+ description: The status condition list of the semantic goal.
1416
+ type: array
1417
+ items:
1418
+ type: SemanticGoalStatusConditionOutputRepresentation
1419
+ subMetricDefinitionApiName:
1420
+ description: The API name of the semantic sub metric definition.
1421
+ type: string
1308
1422
  SemanticGoalStatusConditionInputRepresentation:
1309
1423
  description: Input representation for specifying a semantic metric goal status condition
1310
1424
  type: object
@@ -1880,7 +1994,7 @@ types:
1880
1994
  type: string
1881
1995
  required: false
1882
1996
  decimalPlace:
1883
- description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio field.
1997
+ description: The number of decimals places. Optional, if not specified, will use the original decimal places from the dmo/cio/dlo field.
1884
1998
  type: integer
1885
1999
  required: false
1886
2000
  displayCategory:
@@ -4257,6 +4371,46 @@ types:
4257
4371
  - Parameter
4258
4372
  - Relationship
4259
4373
  (oas-collectionFormat): csv
4374
+ /goals:
4375
+ get:
4376
+ displayName: getSemanticGoal
4377
+ description: Retrieves a specific Semantic Goal.
4378
+ responses:
4379
+ '200':
4380
+ description: Success
4381
+ body:
4382
+ application/json:
4383
+ type: SemanticGoalOutputRepresentation
4384
+ queryParameters:
4385
+ endDate:
4386
+ description: The end date of the desired goal.
4387
+ type: string
4388
+ required: false
4389
+ startDate:
4390
+ description: The start date of the desired goal.
4391
+ type: string
4392
+ required: false
4393
+ subMetricApiNameOrId:
4394
+ description: The Semantic Sub Metric Id related to the desired goal.
4395
+ type: string
4396
+ required: false
4397
+ post:
4398
+ displayName: postSemanticGoal
4399
+ description: Creates a new semantic goal
4400
+ responses:
4401
+ '200':
4402
+ description: Success
4403
+ body:
4404
+ application/json:
4405
+ type: SemanticGoalOutputRepresentation
4406
+ body:
4407
+ application/json:
4408
+ type: SemanticGoalInputRepresentation
4409
+ (oas-body-name): inputName
4410
+ uriParameters:
4411
+ modelApiNameOrId:
4412
+ type: string
4413
+ required: true
4260
4414
  /groupings:
4261
4415
  get:
4262
4416
  displayName: getSemanticGroupingCollection
@@ -53,6 +53,9 @@ types:
53
53
  SemanticGroupingOutputRepresentation:
54
54
  (luvio.key):
55
55
  name: id
56
+ SemanticGoalOutputRepresentation:
57
+ (luvio.key):
58
+ name: id
56
59
 
57
60
  /ssot/semantic/models:
58
61
  get:
@@ -126,3 +129,12 @@ types:
126
129
  name: urlParams.subMetricNameOrId
127
130
  (luvio.adapter):
128
131
  name: deleteGoalFromSubMetric
132
+ /goals:
133
+ get:
134
+ (luvio.key):
135
+ name: urlParams.modelApiNameOrId
136
+ (luvio.adapter):
137
+ name: getSemanticGoal
138
+ post:
139
+ (luvio.adapter):
140
+ name: createSemanticGoal