@salesforce/lds-adapters-sales-enablement-program 1.100.2
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/LICENSE.txt +82 -0
- package/dist/es/es2018/sales-enablement-program.js +1584 -0
- package/dist/types/src/generated/adapters/adapter-utils.d.ts +66 -0
- package/dist/types/src/generated/adapters/getProgramTemplate.d.ts +26 -0
- package/dist/types/src/generated/adapters/getProgramTemplates.d.ts +25 -0
- package/dist/types/src/generated/artifacts/main.d.ts +2 -0
- package/dist/types/src/generated/artifacts/sfdc.d.ts +5 -0
- package/dist/types/src/generated/resources/deleteConnectEnablementMeasure.d.ts +8 -0
- package/dist/types/src/generated/resources/deleteConnectEnablementMeasureByMeasureId.d.ts +11 -0
- package/dist/types/src/generated/resources/getConnectEnablementMeasure.d.ts +12 -0
- package/dist/types/src/generated/resources/getConnectEnablementMeasureByMeasureId.d.ts +15 -0
- package/dist/types/src/generated/resources/getConnectEnablementMeasureCloneActionBySourceMeasureId.d.ts +15 -0
- package/dist/types/src/generated/resources/getConnectEnablementProgramByEnablementProgramId.d.ts +15 -0
- package/dist/types/src/generated/resources/getConnectEnablementProgramDescribeByEnablementProgramId.d.ts +15 -0
- package/dist/types/src/generated/resources/getConnectEnablementProgramSummaryAssigned.d.ts +12 -0
- package/dist/types/src/generated/resources/getConnectEnablementProgramSummaryByEnablementProgramId.d.ts +15 -0
- package/dist/types/src/generated/resources/getConnectEnablementProgramTemplate.d.ts +12 -0
- package/dist/types/src/generated/resources/getConnectEnablementProgramTemplateByProgramTemplateName.d.ts +15 -0
- package/dist/types/src/generated/resources/getConnectEnablementProgramsDescribeByEnablementProgramId.d.ts +15 -0
- package/dist/types/src/generated/resources/patchConnectEnablementMeasure.d.ts +10 -0
- package/dist/types/src/generated/resources/patchConnectEnablementMeasureByMeasureId.d.ts +13 -0
- package/dist/types/src/generated/resources/patchConnectEnablementProgram.d.ts +14 -0
- package/dist/types/src/generated/resources/patchConnectEnablementPrograms.d.ts +14 -0
- package/dist/types/src/generated/resources/patchConnectEnablementProgramsByEnablementProgramId.d.ts +17 -0
- package/dist/types/src/generated/resources/postConnectEnablementMeasure.d.ts +20 -0
- package/dist/types/src/generated/resources/postConnectEnablementMeasureByMeasureId.d.ts +23 -0
- package/dist/types/src/generated/resources/postConnectEnablementProgram.d.ts +17 -0
- package/dist/types/src/generated/resources/postConnectEnablementProgramStatus.d.ts +13 -0
- package/dist/types/src/generated/resources/postConnectEnablementProgramStatusByEnablementProgramId.d.ts +16 -0
- package/dist/types/src/generated/resources/postConnectEnablementPrograms.d.ts +17 -0
- package/dist/types/src/generated/resources/postConnectEnablementProgramsByEnablementProgramId.d.ts +20 -0
- package/dist/types/src/generated/resources/postConnectEnablementProgramsStatus.d.ts +13 -0
- package/dist/types/src/generated/resources/postConnectEnablementProgramsStatusByEnablementProgramId.d.ts +16 -0
- package/dist/types/src/generated/resources/putConnectEnablementMeasure.d.ts +17 -0
- package/dist/types/src/generated/resources/putConnectEnablementMeasureByMeasureId.d.ts +20 -0
- package/dist/types/src/generated/types/AbstractEnablementProgramRepresentation.d.ts +49 -0
- package/dist/types/src/generated/types/AbstractEnablementProgramTaskRepresentation.d.ts +95 -0
- package/dist/types/src/generated/types/EnablementMeasureFilterInputRepresentation.d.ts +41 -0
- package/dist/types/src/generated/types/EnablementMeasureFilterRepresentation.d.ts +41 -0
- package/dist/types/src/generated/types/EnablementMeasureIdRepresentation.d.ts +29 -0
- package/dist/types/src/generated/types/EnablementMeasureInputRepresentation.d.ts +53 -0
- package/dist/types/src/generated/types/EnablementMeasureObjectInputRepresentation.d.ts +50 -0
- package/dist/types/src/generated/types/EnablementMeasureObjectRepresentation.d.ts +51 -0
- package/dist/types/src/generated/types/EnablementMeasureRepresentation.d.ts +63 -0
- package/dist/types/src/generated/types/EnablementMeasureStatusInputRepresentation.d.ts +32 -0
- package/dist/types/src/generated/types/EnablementProgramInputRepresentation.d.ts +44 -0
- package/dist/types/src/generated/types/EnablementProgramRepresentation.d.ts +56 -0
- package/dist/types/src/generated/types/EnablementProgramRuntimeRepresentation.d.ts +64 -0
- package/dist/types/src/generated/types/EnablementProgramRuntimeTaskRepresentation.d.ts +107 -0
- package/dist/types/src/generated/types/EnablementProgramSectionInputRepresentation.d.ts +44 -0
- package/dist/types/src/generated/types/EnablementProgramSectionRepresentation.d.ts +42 -0
- package/dist/types/src/generated/types/EnablementProgramStatusRepresentation.d.ts +32 -0
- package/dist/types/src/generated/types/EnablementProgramStatusUpdateInputRepresentation.d.ts +32 -0
- package/dist/types/src/generated/types/EnablementProgramSummaryItemRepresentation.d.ts +47 -0
- package/dist/types/src/generated/types/EnablementProgramSummaryListRepresentation.d.ts +30 -0
- package/dist/types/src/generated/types/EnablementProgramSummaryRepresentation.d.ts +52 -0
- package/dist/types/src/generated/types/EnablementProgramSummarySectionRepresentation.d.ts +32 -0
- package/dist/types/src/generated/types/EnablementProgramSummaryTaskRepresentation.d.ts +64 -0
- package/dist/types/src/generated/types/EnablementProgramTaskInputRepresentation.d.ts +77 -0
- package/dist/types/src/generated/types/EnablementProgramTaskRepresentation.d.ts +96 -0
- package/dist/types/src/generated/types/ProgramTaskWarningRepresentation.d.ts +35 -0
- package/dist/types/src/generated/types/ProgramTemplateInfoRepresentation.d.ts +35 -0
- package/dist/types/src/generated/types/ProgramTemplateListRepresentation.d.ts +31 -0
- package/dist/types/src/generated/types/type-utils.d.ts +39 -0
- package/dist/umd/es2018/sales-enablement-program.js +1593 -0
- package/dist/umd/es5/sales-enablement-program.js +1598 -0
- package/package.json +71 -0
- package/sfdc/index.d.ts +1 -0
- package/sfdc/index.js +1624 -0
- package/src/raml/api.raml +1406 -0
- package/src/raml/luvio.raml +25 -0
|
@@ -0,0 +1,1406 @@
|
|
|
1
|
+
#%RAML 1.0
|
|
2
|
+
securedBy:
|
|
3
|
+
- OAuth2
|
|
4
|
+
title: Salesforce Connect API
|
|
5
|
+
version: '58.0'
|
|
6
|
+
mediaType: application/json
|
|
7
|
+
protocols:
|
|
8
|
+
- https
|
|
9
|
+
baseUri: /services/data/v58.0
|
|
10
|
+
securitySchemes:
|
|
11
|
+
OAuth2:
|
|
12
|
+
type: OAuth 2.0
|
|
13
|
+
settings:
|
|
14
|
+
authorizationUri: https://example.com/oauth/authorize
|
|
15
|
+
accessTokenUri: ''
|
|
16
|
+
authorizationGrants:
|
|
17
|
+
- implicit
|
|
18
|
+
annotationTypes:
|
|
19
|
+
oas-readOnly:
|
|
20
|
+
type: boolean
|
|
21
|
+
allowedTargets: TypeDeclaration
|
|
22
|
+
oas-collectionFormat:
|
|
23
|
+
type: string
|
|
24
|
+
oas-body-name:
|
|
25
|
+
type: string
|
|
26
|
+
allowedTargets: TypeDeclaration
|
|
27
|
+
types:
|
|
28
|
+
AbstractEnablementProgramRepresentation:
|
|
29
|
+
description: Common Enablement Program representation
|
|
30
|
+
type: object
|
|
31
|
+
properties:
|
|
32
|
+
description:
|
|
33
|
+
description: Description of the enablement program
|
|
34
|
+
type: string
|
|
35
|
+
id:
|
|
36
|
+
description: Id of the enablement program
|
|
37
|
+
type: string
|
|
38
|
+
isOutcomeBased:
|
|
39
|
+
description: True if and only if this enablement program is an outcome based
|
|
40
|
+
one
|
|
41
|
+
type: boolean
|
|
42
|
+
name:
|
|
43
|
+
description: Name of the enablement program
|
|
44
|
+
type: string
|
|
45
|
+
sections:
|
|
46
|
+
description: List of sections for the enablement program
|
|
47
|
+
type: array
|
|
48
|
+
items:
|
|
49
|
+
type: EnablementProgramSectionRepresentation
|
|
50
|
+
status:
|
|
51
|
+
description: Status of the enablement program
|
|
52
|
+
type: string
|
|
53
|
+
enum:
|
|
54
|
+
- Archived
|
|
55
|
+
- Draft
|
|
56
|
+
- Published
|
|
57
|
+
tasks:
|
|
58
|
+
description: List of tasks for the enablement program
|
|
59
|
+
type: array
|
|
60
|
+
items:
|
|
61
|
+
type: AbstractEnablementProgramTaskRepresentation
|
|
62
|
+
AbstractEnablementProgramTaskRepresentation:
|
|
63
|
+
description: Common Enablement Program item representation
|
|
64
|
+
type: object
|
|
65
|
+
properties:
|
|
66
|
+
contentType:
|
|
67
|
+
description: Content type for the enablement task
|
|
68
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
69
|
+
enum:
|
|
70
|
+
- CmsLink
|
|
71
|
+
- CmsTextLesson
|
|
72
|
+
- CmsVideoLink
|
|
73
|
+
- EnablementRoom
|
|
74
|
+
- Link
|
|
75
|
+
- Measure
|
|
76
|
+
- TrailheadModule
|
|
77
|
+
- TrailheadTextLesson
|
|
78
|
+
- TrailheadVideoLesson
|
|
79
|
+
- VideoLink
|
|
80
|
+
description:
|
|
81
|
+
description: Description of the enablement task
|
|
82
|
+
type: string
|
|
83
|
+
developerName:
|
|
84
|
+
description: DeveloperName of the enablement task
|
|
85
|
+
type: string
|
|
86
|
+
durationCount:
|
|
87
|
+
description: The estimated duration, in minutes, of the task.
|
|
88
|
+
type: integer | nil # TODO hand rolled. W-11194242
|
|
89
|
+
enablementProgramSectionId:
|
|
90
|
+
description: Program Section Id of the enablement task
|
|
91
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
92
|
+
enablementRoomId:
|
|
93
|
+
description: Enablement Room Id of the enablement task
|
|
94
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
95
|
+
id:
|
|
96
|
+
description: Id of the enablement task
|
|
97
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
98
|
+
isMilestoneAnOutcome:
|
|
99
|
+
description: True if and only if this task is an outcome milestone
|
|
100
|
+
type: boolean | nil # TODO hand rolled. W-11194242
|
|
101
|
+
learningItemDescription:
|
|
102
|
+
description: Description of the associated learning item
|
|
103
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
104
|
+
learningItemIconUrl:
|
|
105
|
+
description: The learning item icon url.
|
|
106
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
107
|
+
learningItemId:
|
|
108
|
+
description: Learning Item Id of the enablement task
|
|
109
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
110
|
+
learningItemRelatedContentId:
|
|
111
|
+
description: Related content id for the associated learning item
|
|
112
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
113
|
+
learningItemTitle:
|
|
114
|
+
description: Title of the associated learning item
|
|
115
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
116
|
+
learningItemUrl:
|
|
117
|
+
description: Url for the associated learning item
|
|
118
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
119
|
+
milestoneTarget:
|
|
120
|
+
description: Milestone Target of the enablement task
|
|
121
|
+
format: double
|
|
122
|
+
type: number
|
|
123
|
+
minimumSampleSize:
|
|
124
|
+
description: Minimum Sample Size of the enablement measure with aggregation
|
|
125
|
+
type average
|
|
126
|
+
type: integer | nil # TODO hand rolled. W-11194242
|
|
127
|
+
measureId:
|
|
128
|
+
description: measure
|
|
129
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
130
|
+
name:
|
|
131
|
+
description: Name of the enablement task
|
|
132
|
+
type: string
|
|
133
|
+
programDay:
|
|
134
|
+
description: The day the program task is due
|
|
135
|
+
type: integer
|
|
136
|
+
sequenceNumber:
|
|
137
|
+
description: Sequence Number of the enablement task
|
|
138
|
+
type: integer
|
|
139
|
+
taskCategory:
|
|
140
|
+
description: Category Type of the enablement task
|
|
141
|
+
type: string
|
|
142
|
+
enum:
|
|
143
|
+
- Exercise
|
|
144
|
+
- Milestone
|
|
145
|
+
taskSubCategory:
|
|
146
|
+
description: Sub Category Type of the enablement task
|
|
147
|
+
type: string
|
|
148
|
+
enum:
|
|
149
|
+
- AudioRecording
|
|
150
|
+
- Document
|
|
151
|
+
- Other
|
|
152
|
+
- OtherExercise
|
|
153
|
+
- ScheduledEvent
|
|
154
|
+
- TextLesson
|
|
155
|
+
- Trailhead
|
|
156
|
+
- Video
|
|
157
|
+
warnings: # TODO hand rolled. W-11194242
|
|
158
|
+
description: additional property in connect API
|
|
159
|
+
type: any
|
|
160
|
+
EnablementMeasureFilterInputRepresentation:
|
|
161
|
+
description: Enablement Measure Filter Input Representation
|
|
162
|
+
type: object
|
|
163
|
+
properties:
|
|
164
|
+
fieldApiName:
|
|
165
|
+
description: Enablement Measure Filter Field Api Name
|
|
166
|
+
type: string
|
|
167
|
+
fieldValue:
|
|
168
|
+
description: Enablement Measure Filter Field Value
|
|
169
|
+
type: string
|
|
170
|
+
measureFilterId:
|
|
171
|
+
description: Enablement Measure Filter Id
|
|
172
|
+
type: string
|
|
173
|
+
operator:
|
|
174
|
+
description: Enablement Measure Filter Operator Name
|
|
175
|
+
type: string
|
|
176
|
+
enum:
|
|
177
|
+
- Contains
|
|
178
|
+
- DoesNotEqual
|
|
179
|
+
- EndsWith
|
|
180
|
+
- Equals
|
|
181
|
+
- GreaterThan
|
|
182
|
+
- GreaterThanOrEqual
|
|
183
|
+
- In
|
|
184
|
+
- IsNull
|
|
185
|
+
- LessThan
|
|
186
|
+
- LessThanOrEqual
|
|
187
|
+
- NotIn
|
|
188
|
+
- StartsWith
|
|
189
|
+
sequenceNumber:
|
|
190
|
+
description: 'Enablement Measure Filter Sequence Number '
|
|
191
|
+
type: integer
|
|
192
|
+
EnablementMeasureFilterRepresentation:
|
|
193
|
+
description: Enablement Measure Filter Output Representation
|
|
194
|
+
type: object
|
|
195
|
+
properties:
|
|
196
|
+
fieldApiName:
|
|
197
|
+
description: Enablement Measure Filter Field Api Name
|
|
198
|
+
type: string
|
|
199
|
+
fieldValue:
|
|
200
|
+
description: Enablement Measure Filter Field Value
|
|
201
|
+
type: string
|
|
202
|
+
measureFilterId:
|
|
203
|
+
description: Enablement Measure Filter Id
|
|
204
|
+
type: string
|
|
205
|
+
operator:
|
|
206
|
+
description: Enablement Measure Filter Operator Name
|
|
207
|
+
type: string
|
|
208
|
+
enum:
|
|
209
|
+
- Contains
|
|
210
|
+
- DoesNotEqual
|
|
211
|
+
- EndsWith
|
|
212
|
+
- Equals
|
|
213
|
+
- GreaterThan
|
|
214
|
+
- GreaterThanOrEqual
|
|
215
|
+
- In
|
|
216
|
+
- IsNull
|
|
217
|
+
- LessThan
|
|
218
|
+
- LessThanOrEqual
|
|
219
|
+
- NotIn
|
|
220
|
+
- StartsWith
|
|
221
|
+
sequenceNumber:
|
|
222
|
+
description: Enablement Measure Filter Sequence Number
|
|
223
|
+
type: integer
|
|
224
|
+
EnablementMeasureIdRepresentation:
|
|
225
|
+
description: Enablement Measure Id Output Representation
|
|
226
|
+
type: object
|
|
227
|
+
properties:
|
|
228
|
+
enablementMeasureId:
|
|
229
|
+
description: Record Id of Enablement Measure
|
|
230
|
+
type: string
|
|
231
|
+
EnablementMeasureInputRepresentation:
|
|
232
|
+
description: Enablement Measure Input Representation
|
|
233
|
+
type: object
|
|
234
|
+
properties:
|
|
235
|
+
aggregateFieldApiName:
|
|
236
|
+
description: Enablement Measure Aggregate Field Api Name
|
|
237
|
+
type: string
|
|
238
|
+
aggregationFunction:
|
|
239
|
+
description: Enablement Measure Aggregation Function
|
|
240
|
+
type: string
|
|
241
|
+
enum:
|
|
242
|
+
- Average
|
|
243
|
+
- Count
|
|
244
|
+
- Sum
|
|
245
|
+
description:
|
|
246
|
+
description: Enablement Measure Description
|
|
247
|
+
type: string
|
|
248
|
+
displayFieldApiName:
|
|
249
|
+
description: Enablement Measure Display Field Api Name
|
|
250
|
+
type: string
|
|
251
|
+
measureId:
|
|
252
|
+
description: Enablement Measure Id
|
|
253
|
+
type: string
|
|
254
|
+
name:
|
|
255
|
+
description: Enablement Measure Name
|
|
256
|
+
type: string
|
|
257
|
+
sourceMeasureObject:
|
|
258
|
+
description: Source Enablement Measure Object
|
|
259
|
+
type: object
|
|
260
|
+
sourceMeasureObjectName:
|
|
261
|
+
description: Enablement Source Measure Object Name
|
|
262
|
+
type: string
|
|
263
|
+
status:
|
|
264
|
+
description: Enablement Measure Status
|
|
265
|
+
type: string
|
|
266
|
+
enum:
|
|
267
|
+
- Archived
|
|
268
|
+
- Draft
|
|
269
|
+
- Published
|
|
270
|
+
EnablementMeasureObjectInputRepresentation:
|
|
271
|
+
description: Enablement Measure Object Input Representation
|
|
272
|
+
type: object
|
|
273
|
+
properties:
|
|
274
|
+
childIdFieldApiName:
|
|
275
|
+
description: Child Id Field Api Name
|
|
276
|
+
type: string
|
|
277
|
+
childMeasureObjects:
|
|
278
|
+
description: Child Enablement Measure Objects
|
|
279
|
+
type: array
|
|
280
|
+
items:
|
|
281
|
+
type: object
|
|
282
|
+
filterLogic:
|
|
283
|
+
description: Enablement Measure Filter Logic
|
|
284
|
+
type: string
|
|
285
|
+
measureFilters:
|
|
286
|
+
description: Enablement Measure Filters
|
|
287
|
+
type: array
|
|
288
|
+
items:
|
|
289
|
+
type: object
|
|
290
|
+
measureObjectId:
|
|
291
|
+
description: Enablement Measure Object Id
|
|
292
|
+
type: string
|
|
293
|
+
objectApiName:
|
|
294
|
+
description: Enablement Measure Object Api Name
|
|
295
|
+
type: string
|
|
296
|
+
parentIdFieldApiName:
|
|
297
|
+
description: Parent Id Field Api Name
|
|
298
|
+
type: string
|
|
299
|
+
sequenceNumber:
|
|
300
|
+
description: 'Enablement Measure Object Sequence Number '
|
|
301
|
+
type: integer
|
|
302
|
+
EnablementMeasureObjectRepresentation:
|
|
303
|
+
description: Enablement Measure Object Output Representation
|
|
304
|
+
type: object
|
|
305
|
+
properties:
|
|
306
|
+
childIdFieldApiName:
|
|
307
|
+
description: Child Id Field Api Name
|
|
308
|
+
type: string
|
|
309
|
+
childMeasureObjects:
|
|
310
|
+
description: Child Enablement Measure Objects
|
|
311
|
+
type: array
|
|
312
|
+
items:
|
|
313
|
+
type: EnablementMeasureObjectRepresentation
|
|
314
|
+
filterLogic:
|
|
315
|
+
description: Enablement Measure Filter Logic
|
|
316
|
+
type: string
|
|
317
|
+
measureFilters:
|
|
318
|
+
description: Enablement Measure Filters
|
|
319
|
+
type: array
|
|
320
|
+
items:
|
|
321
|
+
type: EnablementMeasureFilterRepresentation
|
|
322
|
+
measureObjectId:
|
|
323
|
+
description: Enablement Measure Object Id
|
|
324
|
+
type: string
|
|
325
|
+
objectApiName:
|
|
326
|
+
description: Enablement Measure Object Api Name
|
|
327
|
+
type: string
|
|
328
|
+
parentIdFieldApiName:
|
|
329
|
+
description: Parent Id Field Api Name
|
|
330
|
+
type: string
|
|
331
|
+
sequenceNumber:
|
|
332
|
+
description: Enablement Measure Object Sequence Number
|
|
333
|
+
type: integer
|
|
334
|
+
EnablementMeasureRepresentation:
|
|
335
|
+
description: Enablement Measure Output Representation
|
|
336
|
+
type: object
|
|
337
|
+
properties:
|
|
338
|
+
aggregateFieldApiName:
|
|
339
|
+
description: Enablement Measure Aggregate Field Api Name
|
|
340
|
+
type: string
|
|
341
|
+
aggregationFunction:
|
|
342
|
+
description: Enablement Measure Aggregation Function
|
|
343
|
+
type: string
|
|
344
|
+
enum:
|
|
345
|
+
- Average
|
|
346
|
+
- Count
|
|
347
|
+
- Sum
|
|
348
|
+
description:
|
|
349
|
+
description: Enablement Measure Description
|
|
350
|
+
type: string
|
|
351
|
+
displayFieldApiName:
|
|
352
|
+
description: Enablement Measure Display Field Api Name
|
|
353
|
+
type: string
|
|
354
|
+
isValid:
|
|
355
|
+
description: Flag to indicate whether or not the measure is valid
|
|
356
|
+
type: boolean
|
|
357
|
+
measureId:
|
|
358
|
+
description: Enablement Measure Id
|
|
359
|
+
type: string
|
|
360
|
+
name:
|
|
361
|
+
description: Enablement Measure Name
|
|
362
|
+
type: string
|
|
363
|
+
sourceMeasureObject:
|
|
364
|
+
description: Source Enablement Measure Object
|
|
365
|
+
type: EnablementMeasureObjectRepresentation
|
|
366
|
+
sourceMeasureObjectName:
|
|
367
|
+
description: Enablement Source Measure Object Name
|
|
368
|
+
type: string
|
|
369
|
+
sourceObjectDateField:
|
|
370
|
+
description: Enablement Measure Source Object Date Field Api Name
|
|
371
|
+
type: string
|
|
372
|
+
sourceObjectUserField:
|
|
373
|
+
description: Enablement Measure Source Object User Field Api Name
|
|
374
|
+
type: string
|
|
375
|
+
status:
|
|
376
|
+
description: Enablement Measure Status
|
|
377
|
+
type: string
|
|
378
|
+
enum:
|
|
379
|
+
- Archived
|
|
380
|
+
- Draft
|
|
381
|
+
- Published
|
|
382
|
+
EnablementMeasureStatusInputRepresentation:
|
|
383
|
+
description: Enablement Measure Status Input Representation
|
|
384
|
+
type: object
|
|
385
|
+
properties:
|
|
386
|
+
measureId:
|
|
387
|
+
description: Enablement Measure Id
|
|
388
|
+
type: string
|
|
389
|
+
measureStatus:
|
|
390
|
+
description: Enablement Measure Status
|
|
391
|
+
type: string
|
|
392
|
+
enum:
|
|
393
|
+
- Archived
|
|
394
|
+
- Draft
|
|
395
|
+
- Published
|
|
396
|
+
EnablementProgramInputRepresentation:
|
|
397
|
+
description: Enablement representation of an enablement program. Contains program
|
|
398
|
+
details.
|
|
399
|
+
type: object
|
|
400
|
+
properties:
|
|
401
|
+
description:
|
|
402
|
+
description: Description of the enablement program
|
|
403
|
+
type: string
|
|
404
|
+
id:
|
|
405
|
+
description: Id of the enablement program
|
|
406
|
+
type: string
|
|
407
|
+
items:
|
|
408
|
+
description: List of items for the enablement program
|
|
409
|
+
type: array
|
|
410
|
+
items:
|
|
411
|
+
type: object
|
|
412
|
+
name:
|
|
413
|
+
description: Name of the enablement program
|
|
414
|
+
type: string
|
|
415
|
+
sections:
|
|
416
|
+
description: List of sections for the enablement program
|
|
417
|
+
type: array
|
|
418
|
+
items:
|
|
419
|
+
type: object
|
|
420
|
+
templateId:
|
|
421
|
+
description: Id of Program template
|
|
422
|
+
type: string
|
|
423
|
+
EnablementProgramRepresentation:
|
|
424
|
+
description: Runtime representation of an enablement program. Contains only program
|
|
425
|
+
details
|
|
426
|
+
type: object
|
|
427
|
+
properties:
|
|
428
|
+
description:
|
|
429
|
+
description: Description of the enablement program
|
|
430
|
+
type: string
|
|
431
|
+
id:
|
|
432
|
+
description: Id of the enablement program
|
|
433
|
+
type: string | nil # TODO hand rolled. W-11194446
|
|
434
|
+
isOutcomeBased:
|
|
435
|
+
description: True if and only if this enablement program is an outcome based
|
|
436
|
+
one
|
|
437
|
+
type: boolean
|
|
438
|
+
name:
|
|
439
|
+
description: Name of the enablement program
|
|
440
|
+
type: string
|
|
441
|
+
sections:
|
|
442
|
+
description: List of sections for the enablement program
|
|
443
|
+
type: array
|
|
444
|
+
items:
|
|
445
|
+
type: EnablementProgramSectionRepresentation
|
|
446
|
+
status:
|
|
447
|
+
description: Status of the enablement program
|
|
448
|
+
type: string
|
|
449
|
+
enum:
|
|
450
|
+
- Archived
|
|
451
|
+
- Draft
|
|
452
|
+
- Published
|
|
453
|
+
tasks:
|
|
454
|
+
description: List of tasks for the enablement program
|
|
455
|
+
type: array
|
|
456
|
+
items:
|
|
457
|
+
type: AbstractEnablementProgramTaskRepresentation
|
|
458
|
+
isTemplate:
|
|
459
|
+
description: True if and only if this enablement program is a template definition
|
|
460
|
+
type: boolean
|
|
461
|
+
systemModStamp:
|
|
462
|
+
description: SystemModStamp of the enablement program
|
|
463
|
+
type: string
|
|
464
|
+
EnablementProgramRuntimeRepresentation:
|
|
465
|
+
description: Runtime representation of an enablement program. Contains program
|
|
466
|
+
details as well as progress for the current user.
|
|
467
|
+
type: object
|
|
468
|
+
properties:
|
|
469
|
+
description:
|
|
470
|
+
description: Description of the enablement program
|
|
471
|
+
type: string
|
|
472
|
+
id:
|
|
473
|
+
description: Id of the enablement program
|
|
474
|
+
type: string
|
|
475
|
+
isOutcomeBased:
|
|
476
|
+
description: True if and only if this enablement program is an outcome based
|
|
477
|
+
one
|
|
478
|
+
type: boolean
|
|
479
|
+
name:
|
|
480
|
+
description: Name of the enablement program
|
|
481
|
+
type: string
|
|
482
|
+
sections:
|
|
483
|
+
description: List of sections for the enablement program
|
|
484
|
+
type: array
|
|
485
|
+
items:
|
|
486
|
+
type: EnablementProgramSectionRepresentation
|
|
487
|
+
status:
|
|
488
|
+
description: Status of the enablement program
|
|
489
|
+
type: string
|
|
490
|
+
enum:
|
|
491
|
+
- Archived
|
|
492
|
+
- Draft
|
|
493
|
+
- Published
|
|
494
|
+
tasks:
|
|
495
|
+
description: List of tasks for the enablement program
|
|
496
|
+
type: array
|
|
497
|
+
items:
|
|
498
|
+
type: AbstractEnablementProgramTaskRepresentation
|
|
499
|
+
completedDate:
|
|
500
|
+
description: Completed date of the enablement program for the current user
|
|
501
|
+
type: string
|
|
502
|
+
completedPercent:
|
|
503
|
+
description: Percent complete of the enablement program for the current user
|
|
504
|
+
format: double
|
|
505
|
+
type: number
|
|
506
|
+
dueDate:
|
|
507
|
+
description: Due date of the enablement program for the current user
|
|
508
|
+
type: string
|
|
509
|
+
isCompleted:
|
|
510
|
+
description: Indicates if the current user has completed the enablement program
|
|
511
|
+
type: boolean
|
|
512
|
+
isOverdue:
|
|
513
|
+
description: Indicates if the current user is overdue on the enablement program
|
|
514
|
+
type: boolean
|
|
515
|
+
EnablementProgramRuntimeTaskRepresentation:
|
|
516
|
+
description: Runtime representation of an enablement program task. Contains task
|
|
517
|
+
details as well as user progress.
|
|
518
|
+
type: object
|
|
519
|
+
properties:
|
|
520
|
+
contentType:
|
|
521
|
+
description: Content type for the enablement task
|
|
522
|
+
type: string
|
|
523
|
+
enum:
|
|
524
|
+
- CmsLink
|
|
525
|
+
- CmsTextLesson
|
|
526
|
+
- CmsVideoLink
|
|
527
|
+
- EnablementRoom
|
|
528
|
+
- Link
|
|
529
|
+
- Measure
|
|
530
|
+
- TrailheadModule
|
|
531
|
+
- TrailheadTextLesson
|
|
532
|
+
- TrailheadVideoLesson
|
|
533
|
+
- VideoLink
|
|
534
|
+
description:
|
|
535
|
+
description: Description of the enablement task
|
|
536
|
+
type: string
|
|
537
|
+
developerName:
|
|
538
|
+
description: DeveloperName of the enablement task
|
|
539
|
+
type: string
|
|
540
|
+
durationCount:
|
|
541
|
+
description: The estimated duration, in minutes, of the task.
|
|
542
|
+
type: integer
|
|
543
|
+
enablementProgramSectionId:
|
|
544
|
+
description: Program Section Id of the enablement task
|
|
545
|
+
type: string
|
|
546
|
+
enablementRoomId:
|
|
547
|
+
description: Enablement Room Id of the enablement task
|
|
548
|
+
type: string
|
|
549
|
+
id:
|
|
550
|
+
description: Id of the enablement task
|
|
551
|
+
type: string
|
|
552
|
+
required: false # TODO hand rolled. W-11194242
|
|
553
|
+
isMilestoneAnOutcome:
|
|
554
|
+
description: True if and only if this task is an outcome milestone
|
|
555
|
+
type: boolean
|
|
556
|
+
learningItemDescription:
|
|
557
|
+
description: Description of the associated learning item
|
|
558
|
+
type: string
|
|
559
|
+
learningItemIconUrl:
|
|
560
|
+
description: The learning item icon url.
|
|
561
|
+
type: string
|
|
562
|
+
learningItemId:
|
|
563
|
+
description: Learning Item Id of the enablement task
|
|
564
|
+
type: string
|
|
565
|
+
learningItemRelatedContentId:
|
|
566
|
+
description: Related content id for the associated learning item
|
|
567
|
+
type: string
|
|
568
|
+
learningItemTitle:
|
|
569
|
+
description: Title of the associated learning item
|
|
570
|
+
type: string
|
|
571
|
+
learningItemUrl:
|
|
572
|
+
description: Url for the associated learning item
|
|
573
|
+
type: string
|
|
574
|
+
milestoneTarget:
|
|
575
|
+
description: Milestone Target of the enablement task
|
|
576
|
+
format: double
|
|
577
|
+
type: number
|
|
578
|
+
minimumSampleSize:
|
|
579
|
+
description: Minimum Sample Size of the enablement measure with aggregation
|
|
580
|
+
type average
|
|
581
|
+
type: integer
|
|
582
|
+
name:
|
|
583
|
+
description: Name of the enablement task
|
|
584
|
+
type: string
|
|
585
|
+
programDay:
|
|
586
|
+
description: The day the program task is due
|
|
587
|
+
type: integer
|
|
588
|
+
sequenceNumber:
|
|
589
|
+
description: Sequence Number of the enablement task
|
|
590
|
+
type: integer
|
|
591
|
+
taskCategory:
|
|
592
|
+
description: Category Type of the enablement task
|
|
593
|
+
type: string
|
|
594
|
+
enum:
|
|
595
|
+
- Exercise
|
|
596
|
+
- Milestone
|
|
597
|
+
taskSubCategory:
|
|
598
|
+
description: Sub Category Type of the enablement task
|
|
599
|
+
type: string
|
|
600
|
+
enum:
|
|
601
|
+
- AudioRecording
|
|
602
|
+
- Document
|
|
603
|
+
- Other
|
|
604
|
+
- OtherExercise
|
|
605
|
+
- ScheduledEvent
|
|
606
|
+
- TextLesson
|
|
607
|
+
- Trailhead
|
|
608
|
+
- Video
|
|
609
|
+
completedDate:
|
|
610
|
+
description: The date the item was completed
|
|
611
|
+
type: string
|
|
612
|
+
completedPercent:
|
|
613
|
+
description: Percent complete for the current user
|
|
614
|
+
format: double
|
|
615
|
+
type: number
|
|
616
|
+
dueDate:
|
|
617
|
+
description: Due date for the current assignment
|
|
618
|
+
type: string
|
|
619
|
+
isCompleted:
|
|
620
|
+
description: Indicates if the item is complete or not
|
|
621
|
+
type: boolean
|
|
622
|
+
isOverdue:
|
|
623
|
+
description: Indicates if the item is overdue or not
|
|
624
|
+
type: boolean
|
|
625
|
+
milestoneResult:
|
|
626
|
+
description: The result value of if the task is of measure type
|
|
627
|
+
format: double
|
|
628
|
+
type: number
|
|
629
|
+
EnablementProgramSectionInputRepresentation:
|
|
630
|
+
description: Builder representation of an enablement program section. Contains
|
|
631
|
+
section details for a enablement Program.
|
|
632
|
+
type: object
|
|
633
|
+
properties:
|
|
634
|
+
description:
|
|
635
|
+
description: Description of the enablement program section
|
|
636
|
+
type: string
|
|
637
|
+
enablementProgram:
|
|
638
|
+
description: Enablement Program for the enablement program section
|
|
639
|
+
type: string
|
|
640
|
+
id:
|
|
641
|
+
description: Id of the enablement program section
|
|
642
|
+
type: string
|
|
643
|
+
items:
|
|
644
|
+
description: List of items for the enablement program section
|
|
645
|
+
type: array
|
|
646
|
+
items:
|
|
647
|
+
type: object
|
|
648
|
+
name:
|
|
649
|
+
description: Name of the enablement program section
|
|
650
|
+
type: string
|
|
651
|
+
sequenceNumber:
|
|
652
|
+
description: Sequence Number of the enablement program section
|
|
653
|
+
type: integer
|
|
654
|
+
EnablementProgramSectionRepresentation:
|
|
655
|
+
description: Runtime representation of an enablement program section.
|
|
656
|
+
type: object
|
|
657
|
+
properties:
|
|
658
|
+
description:
|
|
659
|
+
description: Description of the enablement program section
|
|
660
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
661
|
+
id:
|
|
662
|
+
description: Id of the enablement program section
|
|
663
|
+
type: string | nil # TODO hand rolled. W-11194242
|
|
664
|
+
name:
|
|
665
|
+
description: Name of the enablement program section
|
|
666
|
+
type: string
|
|
667
|
+
sequenceNumber:
|
|
668
|
+
description: Sequence number of the enablement program section
|
|
669
|
+
type: integer
|
|
670
|
+
tasks:
|
|
671
|
+
description: List of items for the enablement program section
|
|
672
|
+
type: array
|
|
673
|
+
items:
|
|
674
|
+
type: AbstractEnablementProgramTaskRepresentation
|
|
675
|
+
EnablementProgramStatusRepresentation:
|
|
676
|
+
description: Enablement Program Status Output Representation
|
|
677
|
+
type: object
|
|
678
|
+
properties:
|
|
679
|
+
enablementProgramId:
|
|
680
|
+
description: Record Id of Enablement Program
|
|
681
|
+
type: string
|
|
682
|
+
enablementProgramStatus:
|
|
683
|
+
description: Status of the enablement program
|
|
684
|
+
type: string
|
|
685
|
+
enum:
|
|
686
|
+
- Archived
|
|
687
|
+
- Draft
|
|
688
|
+
- Published
|
|
689
|
+
EnablementProgramStatusUpdateInputRepresentation:
|
|
690
|
+
description: Enablement Program Status Input Representation
|
|
691
|
+
type: object
|
|
692
|
+
properties:
|
|
693
|
+
programId:
|
|
694
|
+
description: Enablement Program Id
|
|
695
|
+
type: string
|
|
696
|
+
programStatus:
|
|
697
|
+
description: Enablement Program Status
|
|
698
|
+
type: string
|
|
699
|
+
enum:
|
|
700
|
+
- Archived
|
|
701
|
+
- Draft
|
|
702
|
+
- Published
|
|
703
|
+
EnablementProgramSummaryItemRepresentation:
|
|
704
|
+
description: Common Enablement Program Summary item representation
|
|
705
|
+
discriminator: type
|
|
706
|
+
type: object
|
|
707
|
+
properties:
|
|
708
|
+
description:
|
|
709
|
+
description: Description of the enablement program summary item
|
|
710
|
+
type: string
|
|
711
|
+
id:
|
|
712
|
+
description: Id of the enablement program summary item
|
|
713
|
+
type: string
|
|
714
|
+
sequenceNumber:
|
|
715
|
+
description: Sequence Number of the enablement task
|
|
716
|
+
type: integer
|
|
717
|
+
title:
|
|
718
|
+
description: Title of the enablement program summary item
|
|
719
|
+
type: string
|
|
720
|
+
type:
|
|
721
|
+
description: Type of enablement program summary item
|
|
722
|
+
type: string
|
|
723
|
+
enum:
|
|
724
|
+
- Section
|
|
725
|
+
- Task
|
|
726
|
+
EnablementProgramSummaryListRepresentation:
|
|
727
|
+
description: List of Enablement Program Summary Representations
|
|
728
|
+
type: object
|
|
729
|
+
properties:
|
|
730
|
+
programSummaryList:
|
|
731
|
+
description: List of enablement program summaries
|
|
732
|
+
type: array
|
|
733
|
+
items:
|
|
734
|
+
type: EnablementProgramSummaryRepresentation
|
|
735
|
+
EnablementProgramSummaryRepresentation:
|
|
736
|
+
description: Enablement Program Summary Representation
|
|
737
|
+
type: object
|
|
738
|
+
properties:
|
|
739
|
+
description:
|
|
740
|
+
description: Description of the enablement program
|
|
741
|
+
type: string
|
|
742
|
+
dueDate:
|
|
743
|
+
description: Due date for enablement program.
|
|
744
|
+
type: string
|
|
745
|
+
id:
|
|
746
|
+
description: Id of the enablement program
|
|
747
|
+
type: string
|
|
748
|
+
items:
|
|
749
|
+
description: List of items for the enablement program
|
|
750
|
+
type: array
|
|
751
|
+
items:
|
|
752
|
+
type: EnablementProgramSummaryItemRepresentation
|
|
753
|
+
learningItemId:
|
|
754
|
+
description: Learning Item Id of the enablement program
|
|
755
|
+
type: string
|
|
756
|
+
outcome:
|
|
757
|
+
description: Outcome of the enablement program
|
|
758
|
+
type: EnablementProgramSummaryTaskRepresentation
|
|
759
|
+
status:
|
|
760
|
+
description: Status of the enablement program
|
|
761
|
+
type: string
|
|
762
|
+
enum:
|
|
763
|
+
- Archived
|
|
764
|
+
- Draft
|
|
765
|
+
- Published
|
|
766
|
+
title:
|
|
767
|
+
description: Name of the enablement program
|
|
768
|
+
type: string
|
|
769
|
+
EnablementProgramSummarySectionRepresentation:
|
|
770
|
+
description: Runtime representation of enablement program section.
|
|
771
|
+
discriminatorValue: Section
|
|
772
|
+
type: EnablementProgramSummaryItemRepresentation
|
|
773
|
+
properties:
|
|
774
|
+
tasks:
|
|
775
|
+
description: List of tasks for the enablement program section
|
|
776
|
+
type: array
|
|
777
|
+
items:
|
|
778
|
+
type: EnablementProgramSummaryTaskRepresentation
|
|
779
|
+
EnablementProgramSummaryTaskRepresentation:
|
|
780
|
+
description: Runtime representation of enablement program task.
|
|
781
|
+
discriminatorValue: Task
|
|
782
|
+
type: EnablementProgramSummaryItemRepresentation
|
|
783
|
+
properties:
|
|
784
|
+
completedDate:
|
|
785
|
+
description: The date the item was completed
|
|
786
|
+
type: string
|
|
787
|
+
completedPercent:
|
|
788
|
+
description: Percent complete for the current user
|
|
789
|
+
format: double
|
|
790
|
+
type: number
|
|
791
|
+
dueDate:
|
|
792
|
+
description: Due date for the current assignment
|
|
793
|
+
type: string
|
|
794
|
+
enablementProgramSectionId:
|
|
795
|
+
description: Program Section Id of the enablement task
|
|
796
|
+
type: string
|
|
797
|
+
isCompleted:
|
|
798
|
+
description: Indicates if the item is complete or not
|
|
799
|
+
type: boolean
|
|
800
|
+
isOverdue:
|
|
801
|
+
description: Indicates if the item is overdue or not
|
|
802
|
+
type: boolean
|
|
803
|
+
learningItemId:
|
|
804
|
+
description: Learning Item Id of the enablement task
|
|
805
|
+
type: string
|
|
806
|
+
milestoneResult:
|
|
807
|
+
description: The result value of if the task is of measure type
|
|
808
|
+
format: double
|
|
809
|
+
type: number
|
|
810
|
+
milestoneTarget:
|
|
811
|
+
description: Milestone Target of the enablement task
|
|
812
|
+
format: double
|
|
813
|
+
type: number
|
|
814
|
+
programDay:
|
|
815
|
+
description: The day the program task is due
|
|
816
|
+
type: integer
|
|
817
|
+
taskCategory:
|
|
818
|
+
description: Category Type of the enablement task
|
|
819
|
+
type: string
|
|
820
|
+
enum:
|
|
821
|
+
- Exercise
|
|
822
|
+
- Milestone
|
|
823
|
+
taskSubCategory:
|
|
824
|
+
description: Sub Category Type of the enablement task
|
|
825
|
+
type: string
|
|
826
|
+
enum:
|
|
827
|
+
- AudioRecording
|
|
828
|
+
- Document
|
|
829
|
+
- Other
|
|
830
|
+
- OtherExercise
|
|
831
|
+
- ScheduledEvent
|
|
832
|
+
- TextLesson
|
|
833
|
+
- Trailhead
|
|
834
|
+
- Video
|
|
835
|
+
EnablementProgramTaskInputRepresentation:
|
|
836
|
+
description: Builder representation of an enablement program item. Contains item
|
|
837
|
+
details for a enablement Program.
|
|
838
|
+
type: object
|
|
839
|
+
properties:
|
|
840
|
+
day:
|
|
841
|
+
description: Day of the enablement task definition
|
|
842
|
+
type: integer
|
|
843
|
+
description:
|
|
844
|
+
description: Description of the enablement task definition
|
|
845
|
+
type: string
|
|
846
|
+
developerName:
|
|
847
|
+
description: DeveloperName of the enablement task definition
|
|
848
|
+
type: string
|
|
849
|
+
enablementProgram:
|
|
850
|
+
description: Enablement Program of the enablement task definition
|
|
851
|
+
type: string
|
|
852
|
+
enablementProgramSection:
|
|
853
|
+
description: Enablement Program Section of the enablement task definition
|
|
854
|
+
type: string
|
|
855
|
+
enablementRoom:
|
|
856
|
+
description: Enablement Room of the enablement task definition
|
|
857
|
+
type: string
|
|
858
|
+
id:
|
|
859
|
+
description: Id of the enablement task definition
|
|
860
|
+
type: string
|
|
861
|
+
isMilestoneAnOutcome:
|
|
862
|
+
description: Boolean flag to specify if the task is Outcome
|
|
863
|
+
type: boolean
|
|
864
|
+
learningContent:
|
|
865
|
+
description: Learning Content of the enablement task definition
|
|
866
|
+
type: string
|
|
867
|
+
learningItem:
|
|
868
|
+
description: Learning Item of the enablement task definition
|
|
869
|
+
type: string
|
|
870
|
+
measureId:
|
|
871
|
+
description: Measure Id of the enablement task definition
|
|
872
|
+
type: string
|
|
873
|
+
milestoneTarget:
|
|
874
|
+
description: Milestone Target of the enablement task definition
|
|
875
|
+
format: double
|
|
876
|
+
type: number
|
|
877
|
+
minimumSampleSize:
|
|
878
|
+
description: Minimum Sample Size of the enablement task definition
|
|
879
|
+
type: integer
|
|
880
|
+
name:
|
|
881
|
+
description: Name of the enablement task definition
|
|
882
|
+
type: string
|
|
883
|
+
sequenceNumber:
|
|
884
|
+
description: Sequence Number of the enablement task definition
|
|
885
|
+
type: integer
|
|
886
|
+
taskCategory:
|
|
887
|
+
description: Task Category of the enablement task definition
|
|
888
|
+
type: string
|
|
889
|
+
enum:
|
|
890
|
+
- Exercise
|
|
891
|
+
- Milestone
|
|
892
|
+
taskSubCategory:
|
|
893
|
+
description: Task SubCategory of the enablement task definition
|
|
894
|
+
type: string
|
|
895
|
+
enum:
|
|
896
|
+
- AudioRecording
|
|
897
|
+
- Document
|
|
898
|
+
- Other
|
|
899
|
+
- OtherExercise
|
|
900
|
+
- ScheduledEvent
|
|
901
|
+
- TextLesson
|
|
902
|
+
- Trailhead
|
|
903
|
+
- Video
|
|
904
|
+
EnablementProgramTaskRepresentation:
|
|
905
|
+
description: Runtime representation of an enablement program item. Contains item
|
|
906
|
+
details as well as progress for the current user.
|
|
907
|
+
type: object
|
|
908
|
+
properties:
|
|
909
|
+
contentType:
|
|
910
|
+
description: Content type for the enablement task
|
|
911
|
+
type: string
|
|
912
|
+
enum:
|
|
913
|
+
- CmsLink
|
|
914
|
+
- CmsTextLesson
|
|
915
|
+
- CmsVideoLink
|
|
916
|
+
- EnablementRoom
|
|
917
|
+
- Link
|
|
918
|
+
- Measure
|
|
919
|
+
- TrailheadModule
|
|
920
|
+
- TrailheadTextLesson
|
|
921
|
+
- TrailheadVideoLesson
|
|
922
|
+
- VideoLink
|
|
923
|
+
description:
|
|
924
|
+
description: Description of the enablement task
|
|
925
|
+
type: string
|
|
926
|
+
developerName:
|
|
927
|
+
description: DeveloperName of the enablement task
|
|
928
|
+
type: string
|
|
929
|
+
durationCount:
|
|
930
|
+
description: The estimated duration, in minutes, of the task.
|
|
931
|
+
type: integer
|
|
932
|
+
enablementProgramSectionId:
|
|
933
|
+
description: Program Section Id of the enablement task
|
|
934
|
+
type: string
|
|
935
|
+
enablementRoomId:
|
|
936
|
+
description: Enablement Room Id of the enablement task
|
|
937
|
+
type: string
|
|
938
|
+
id:
|
|
939
|
+
description: Id of the enablement task
|
|
940
|
+
type: string
|
|
941
|
+
required: false # TODO hand rolled. W-11194242
|
|
942
|
+
isMilestoneAnOutcome:
|
|
943
|
+
description: True if and only if this task is an outcome milestone
|
|
944
|
+
type: boolean
|
|
945
|
+
learningItemDescription:
|
|
946
|
+
description: Description of the associated learning item
|
|
947
|
+
type: string
|
|
948
|
+
learningItemIconUrl:
|
|
949
|
+
description: The learning item icon url.
|
|
950
|
+
type: string
|
|
951
|
+
learningItemId:
|
|
952
|
+
description: Learning Item Id of the enablement task
|
|
953
|
+
type: string
|
|
954
|
+
learningItemRelatedContentId:
|
|
955
|
+
description: Related content id for the associated learning item
|
|
956
|
+
type: string
|
|
957
|
+
learningItemTitle:
|
|
958
|
+
description: Title of the associated learning item
|
|
959
|
+
type: string
|
|
960
|
+
learningItemUrl:
|
|
961
|
+
description: Url for the associated learning item
|
|
962
|
+
type: string
|
|
963
|
+
milestoneTarget:
|
|
964
|
+
description: Milestone Target of the enablement task
|
|
965
|
+
format: double
|
|
966
|
+
type: number
|
|
967
|
+
minimumSampleSize:
|
|
968
|
+
description: Minimum Sample Size of the enablement measure with aggregation
|
|
969
|
+
type average
|
|
970
|
+
type: integer
|
|
971
|
+
name:
|
|
972
|
+
description: Name of the enablement task
|
|
973
|
+
type: string
|
|
974
|
+
programDay:
|
|
975
|
+
description: The day the program task is due
|
|
976
|
+
type: integer
|
|
977
|
+
sequenceNumber:
|
|
978
|
+
description: Sequence Number of the enablement task
|
|
979
|
+
type: integer
|
|
980
|
+
taskCategory:
|
|
981
|
+
description: Category Type of the enablement task
|
|
982
|
+
type: string
|
|
983
|
+
enum:
|
|
984
|
+
- Exercise
|
|
985
|
+
- Milestone
|
|
986
|
+
taskSubCategory:
|
|
987
|
+
description: Sub Category Type of the enablement task
|
|
988
|
+
type: string
|
|
989
|
+
enum:
|
|
990
|
+
- AudioRecording
|
|
991
|
+
- Document
|
|
992
|
+
- Other
|
|
993
|
+
- OtherExercise
|
|
994
|
+
- ScheduledEvent
|
|
995
|
+
- TextLesson
|
|
996
|
+
- Trailhead
|
|
997
|
+
- Video
|
|
998
|
+
measureId:
|
|
999
|
+
description: Related measure id for the enablement task
|
|
1000
|
+
type: string
|
|
1001
|
+
warnings:
|
|
1002
|
+
description: Related Warnings for the enablement task
|
|
1003
|
+
type: array
|
|
1004
|
+
items:
|
|
1005
|
+
type: ProgramTaskWarningRepresentation
|
|
1006
|
+
ProgramTaskWarningRepresentation:
|
|
1007
|
+
description: Program Task Warning Representation
|
|
1008
|
+
type: object
|
|
1009
|
+
properties:
|
|
1010
|
+
message:
|
|
1011
|
+
description: Message of the error
|
|
1012
|
+
type: string
|
|
1013
|
+
warningSource:
|
|
1014
|
+
description: Id or developer name of the enablement task (measure, TH) that
|
|
1015
|
+
failed
|
|
1016
|
+
type: string
|
|
1017
|
+
warningType:
|
|
1018
|
+
description: Warning type for the enablement task
|
|
1019
|
+
type: string
|
|
1020
|
+
enum:
|
|
1021
|
+
- NotFound
|
|
1022
|
+
- NotValid
|
|
1023
|
+
ProgramTemplateInfoRepresentation:
|
|
1024
|
+
description: Enablement Program Template Info Representation
|
|
1025
|
+
type: object
|
|
1026
|
+
properties:
|
|
1027
|
+
developerName:
|
|
1028
|
+
description: 'DeveloperName that uniquely identifies the program template '
|
|
1029
|
+
type: string
|
|
1030
|
+
iconUrl:
|
|
1031
|
+
description: The relative path to the icon to use for the program template
|
|
1032
|
+
type: string
|
|
1033
|
+
label:
|
|
1034
|
+
description: The localized label for this program template
|
|
1035
|
+
type: string
|
|
1036
|
+
ProgramTemplateListRepresentation:
|
|
1037
|
+
description: List of Program Templates
|
|
1038
|
+
type: object
|
|
1039
|
+
properties:
|
|
1040
|
+
programTemplateList:
|
|
1041
|
+
description: List of Program Definition Templates
|
|
1042
|
+
type: array
|
|
1043
|
+
items:
|
|
1044
|
+
type: ProgramTemplateInfoRepresentation
|
|
1045
|
+
/connect/enablement:
|
|
1046
|
+
/measure:
|
|
1047
|
+
delete:
|
|
1048
|
+
description: HTTP DELETE method to delete an existing Enablement Measure
|
|
1049
|
+
responses:
|
|
1050
|
+
'200':
|
|
1051
|
+
description: Success
|
|
1052
|
+
get:
|
|
1053
|
+
description: HTTP GET method to retrieve an existing Enablement Measure
|
|
1054
|
+
responses:
|
|
1055
|
+
'200':
|
|
1056
|
+
description: Success
|
|
1057
|
+
body:
|
|
1058
|
+
application/json:
|
|
1059
|
+
type: EnablementMeasureRepresentation
|
|
1060
|
+
patch:
|
|
1061
|
+
description: HTTP PATCH method to update existing Enablement Measure's Status
|
|
1062
|
+
responses:
|
|
1063
|
+
'200':
|
|
1064
|
+
description: Success
|
|
1065
|
+
body:
|
|
1066
|
+
application/json:
|
|
1067
|
+
type: EnablementMeasureIdRepresentation
|
|
1068
|
+
body:
|
|
1069
|
+
application/json:
|
|
1070
|
+
type: EnablementMeasureStatusInputRepresentation
|
|
1071
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1072
|
+
(oas-body-name): measureStatus
|
|
1073
|
+
post:
|
|
1074
|
+
description: HTTP POST method to create a new Enablement Measure
|
|
1075
|
+
responses:
|
|
1076
|
+
'200':
|
|
1077
|
+
description: Success
|
|
1078
|
+
body:
|
|
1079
|
+
application/json:
|
|
1080
|
+
type: EnablementMeasureIdRepresentation
|
|
1081
|
+
body:
|
|
1082
|
+
application/json:
|
|
1083
|
+
type: EnablementMeasureInputRepresentation
|
|
1084
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1085
|
+
(oas-body-name): measure
|
|
1086
|
+
put:
|
|
1087
|
+
description: HTTP PUT method to update existing Enablement Measure
|
|
1088
|
+
responses:
|
|
1089
|
+
'200':
|
|
1090
|
+
description: Success
|
|
1091
|
+
body:
|
|
1092
|
+
application/json:
|
|
1093
|
+
type: EnablementMeasureIdRepresentation
|
|
1094
|
+
body:
|
|
1095
|
+
application/json:
|
|
1096
|
+
type: EnablementMeasureInputRepresentation
|
|
1097
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1098
|
+
(oas-body-name): measure
|
|
1099
|
+
/cloneAction/{sourceMeasureId}:
|
|
1100
|
+
get:
|
|
1101
|
+
description: HTTP GET method to get measure representation for cloning an
|
|
1102
|
+
existing Enablement Measure
|
|
1103
|
+
responses:
|
|
1104
|
+
'200':
|
|
1105
|
+
description: Success
|
|
1106
|
+
body:
|
|
1107
|
+
application/json:
|
|
1108
|
+
type: EnablementMeasureRepresentation
|
|
1109
|
+
uriParameters:
|
|
1110
|
+
sourceMeasureId:
|
|
1111
|
+
type: string
|
|
1112
|
+
required: true
|
|
1113
|
+
/{measureId}:
|
|
1114
|
+
delete:
|
|
1115
|
+
description: HTTP DELETE method to delete an existing Enablement Measure
|
|
1116
|
+
responses:
|
|
1117
|
+
'200':
|
|
1118
|
+
description: Success
|
|
1119
|
+
get:
|
|
1120
|
+
description: HTTP GET method to retrieve an existing Enablement Measure
|
|
1121
|
+
responses:
|
|
1122
|
+
'200':
|
|
1123
|
+
description: Success
|
|
1124
|
+
body:
|
|
1125
|
+
application/json:
|
|
1126
|
+
type: EnablementMeasureRepresentation
|
|
1127
|
+
patch:
|
|
1128
|
+
description: HTTP PATCH method to update existing Enablement Measure's Status
|
|
1129
|
+
responses:
|
|
1130
|
+
'200':
|
|
1131
|
+
description: Success
|
|
1132
|
+
body:
|
|
1133
|
+
application/json:
|
|
1134
|
+
type: EnablementMeasureIdRepresentation
|
|
1135
|
+
body:
|
|
1136
|
+
application/json:
|
|
1137
|
+
type: EnablementMeasureStatusInputRepresentation
|
|
1138
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1139
|
+
(oas-body-name): measureStatus
|
|
1140
|
+
post:
|
|
1141
|
+
description: HTTP POST method to create a new Enablement Measure
|
|
1142
|
+
responses:
|
|
1143
|
+
'200':
|
|
1144
|
+
description: Success
|
|
1145
|
+
body:
|
|
1146
|
+
application/json:
|
|
1147
|
+
type: EnablementMeasureIdRepresentation
|
|
1148
|
+
body:
|
|
1149
|
+
application/json:
|
|
1150
|
+
type: EnablementMeasureInputRepresentation
|
|
1151
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1152
|
+
(oas-body-name): measure
|
|
1153
|
+
put:
|
|
1154
|
+
description: HTTP PUT method to update existing Enablement Measure
|
|
1155
|
+
responses:
|
|
1156
|
+
'200':
|
|
1157
|
+
description: Success
|
|
1158
|
+
body:
|
|
1159
|
+
application/json:
|
|
1160
|
+
type: EnablementMeasureIdRepresentation
|
|
1161
|
+
body:
|
|
1162
|
+
application/json:
|
|
1163
|
+
type: EnablementMeasureInputRepresentation
|
|
1164
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1165
|
+
(oas-body-name): measure
|
|
1166
|
+
uriParameters:
|
|
1167
|
+
measureId:
|
|
1168
|
+
type: string
|
|
1169
|
+
required: true
|
|
1170
|
+
/program:
|
|
1171
|
+
patch:
|
|
1172
|
+
description: Update enablement program and task definition
|
|
1173
|
+
responses:
|
|
1174
|
+
'200':
|
|
1175
|
+
description: Success
|
|
1176
|
+
body:
|
|
1177
|
+
application/json:
|
|
1178
|
+
type: EnablementProgramRepresentation
|
|
1179
|
+
body:
|
|
1180
|
+
application/json:
|
|
1181
|
+
type: EnablementProgramInputRepresentation
|
|
1182
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1183
|
+
(oas-body-name): enablementProgram
|
|
1184
|
+
post:
|
|
1185
|
+
description: Creates Enablement Program and Enablement Task Definition
|
|
1186
|
+
responses:
|
|
1187
|
+
'200':
|
|
1188
|
+
description: Success
|
|
1189
|
+
body:
|
|
1190
|
+
application/json:
|
|
1191
|
+
type: EnablementProgramRepresentation
|
|
1192
|
+
body:
|
|
1193
|
+
application/json:
|
|
1194
|
+
type: EnablementProgramInputRepresentation
|
|
1195
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1196
|
+
(oas-body-name): enablementProgram
|
|
1197
|
+
/status:
|
|
1198
|
+
post:
|
|
1199
|
+
description: HTTP POST method to update existing Enablement Program's Status
|
|
1200
|
+
and Creates Learning Item
|
|
1201
|
+
responses:
|
|
1202
|
+
'200':
|
|
1203
|
+
description: Success
|
|
1204
|
+
body:
|
|
1205
|
+
application/json:
|
|
1206
|
+
type: EnablementProgramStatusRepresentation
|
|
1207
|
+
body:
|
|
1208
|
+
application/json:
|
|
1209
|
+
type: EnablementProgramStatusUpdateInputRepresentation
|
|
1210
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1211
|
+
(oas-body-name): enablementProgramStatus
|
|
1212
|
+
/status/{enablementProgramId}:
|
|
1213
|
+
post:
|
|
1214
|
+
description: HTTP POST method to update existing Enablement Program's Status
|
|
1215
|
+
and Creates Learning Item
|
|
1216
|
+
responses:
|
|
1217
|
+
'200':
|
|
1218
|
+
description: Success
|
|
1219
|
+
body:
|
|
1220
|
+
application/json:
|
|
1221
|
+
type: EnablementProgramStatusRepresentation
|
|
1222
|
+
body:
|
|
1223
|
+
application/json:
|
|
1224
|
+
type: EnablementProgramStatusUpdateInputRepresentation
|
|
1225
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1226
|
+
(oas-body-name): enablementProgramStatus
|
|
1227
|
+
uriParameters:
|
|
1228
|
+
enablementProgramId:
|
|
1229
|
+
type: string
|
|
1230
|
+
required: true
|
|
1231
|
+
/summary:
|
|
1232
|
+
/assigned:
|
|
1233
|
+
get:
|
|
1234
|
+
description: Assigned Enablement Program Summary
|
|
1235
|
+
responses:
|
|
1236
|
+
'200':
|
|
1237
|
+
description: Success
|
|
1238
|
+
body:
|
|
1239
|
+
application/json:
|
|
1240
|
+
type: EnablementProgramSummaryListRepresentation
|
|
1241
|
+
/{enablementProgramId}:
|
|
1242
|
+
get:
|
|
1243
|
+
description: Enablement Program Summary
|
|
1244
|
+
responses:
|
|
1245
|
+
'200':
|
|
1246
|
+
description: Success
|
|
1247
|
+
body:
|
|
1248
|
+
application/json:
|
|
1249
|
+
type: EnablementProgramSummaryRepresentation
|
|
1250
|
+
uriParameters:
|
|
1251
|
+
enablementProgramId:
|
|
1252
|
+
type: string
|
|
1253
|
+
required: true
|
|
1254
|
+
/{enablementProgramId}:
|
|
1255
|
+
get:
|
|
1256
|
+
description: Retrieve Enablement Program
|
|
1257
|
+
responses:
|
|
1258
|
+
'200':
|
|
1259
|
+
description: Success
|
|
1260
|
+
body:
|
|
1261
|
+
application/json:
|
|
1262
|
+
type: EnablementProgramRuntimeRepresentation
|
|
1263
|
+
uriParameters:
|
|
1264
|
+
enablementProgramId:
|
|
1265
|
+
type: string
|
|
1266
|
+
required: true
|
|
1267
|
+
/{enablementProgramId}/describe:
|
|
1268
|
+
get:
|
|
1269
|
+
description: Describe Enablement Program
|
|
1270
|
+
responses:
|
|
1271
|
+
'200':
|
|
1272
|
+
description: Success
|
|
1273
|
+
body:
|
|
1274
|
+
application/json:
|
|
1275
|
+
type: EnablementProgramRepresentation
|
|
1276
|
+
uriParameters:
|
|
1277
|
+
enablementProgramId:
|
|
1278
|
+
type: string
|
|
1279
|
+
required: true
|
|
1280
|
+
/programTemplate:
|
|
1281
|
+
get:
|
|
1282
|
+
description: Get Enablement Program Templates
|
|
1283
|
+
responses:
|
|
1284
|
+
'200':
|
|
1285
|
+
description: Success
|
|
1286
|
+
body:
|
|
1287
|
+
application/json:
|
|
1288
|
+
type: ProgramTemplateListRepresentation
|
|
1289
|
+
/programTemplate/{programTemplateName}:
|
|
1290
|
+
get:
|
|
1291
|
+
description: Get Enablement Program Template Details
|
|
1292
|
+
responses:
|
|
1293
|
+
'200':
|
|
1294
|
+
description: Success
|
|
1295
|
+
body:
|
|
1296
|
+
application/json:
|
|
1297
|
+
type: EnablementProgramRepresentation
|
|
1298
|
+
uriParameters:
|
|
1299
|
+
programTemplateName:
|
|
1300
|
+
type: string
|
|
1301
|
+
required: true
|
|
1302
|
+
/programs:
|
|
1303
|
+
patch:
|
|
1304
|
+
description: Update enablement program and task definition
|
|
1305
|
+
responses:
|
|
1306
|
+
'200':
|
|
1307
|
+
description: Success
|
|
1308
|
+
body:
|
|
1309
|
+
application/json:
|
|
1310
|
+
type: EnablementProgramRepresentation
|
|
1311
|
+
body:
|
|
1312
|
+
application/json:
|
|
1313
|
+
type: EnablementProgramInputRepresentation
|
|
1314
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1315
|
+
(oas-body-name): enablementProgram
|
|
1316
|
+
post:
|
|
1317
|
+
description: Creates Enablement Program and Enablement Task Definition
|
|
1318
|
+
responses:
|
|
1319
|
+
'200':
|
|
1320
|
+
description: Success
|
|
1321
|
+
body:
|
|
1322
|
+
application/json:
|
|
1323
|
+
type: EnablementProgramRepresentation
|
|
1324
|
+
body:
|
|
1325
|
+
application/json:
|
|
1326
|
+
type: EnablementProgramInputRepresentation
|
|
1327
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1328
|
+
(oas-body-name): enablementProgram
|
|
1329
|
+
/status:
|
|
1330
|
+
post:
|
|
1331
|
+
description: HTTP POST method to update existing Enablement Program's Status
|
|
1332
|
+
and Creates Learning Item
|
|
1333
|
+
responses:
|
|
1334
|
+
'200':
|
|
1335
|
+
description: Success
|
|
1336
|
+
body:
|
|
1337
|
+
application/json:
|
|
1338
|
+
type: EnablementProgramStatusRepresentation
|
|
1339
|
+
body:
|
|
1340
|
+
application/json:
|
|
1341
|
+
type: EnablementProgramStatusUpdateInputRepresentation
|
|
1342
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1343
|
+
(oas-body-name): enablementProgramStatus
|
|
1344
|
+
/status/{enablementProgramId}:
|
|
1345
|
+
post:
|
|
1346
|
+
description: HTTP POST method to update existing Enablement Program's Status
|
|
1347
|
+
and Creates Learning Item
|
|
1348
|
+
responses:
|
|
1349
|
+
'200':
|
|
1350
|
+
description: Success
|
|
1351
|
+
body:
|
|
1352
|
+
application/json:
|
|
1353
|
+
type: EnablementProgramStatusRepresentation
|
|
1354
|
+
body:
|
|
1355
|
+
application/json:
|
|
1356
|
+
type: EnablementProgramStatusUpdateInputRepresentation
|
|
1357
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1358
|
+
(oas-body-name): enablementProgramStatus
|
|
1359
|
+
uriParameters:
|
|
1360
|
+
enablementProgramId:
|
|
1361
|
+
type: string
|
|
1362
|
+
required: true
|
|
1363
|
+
/{enablementProgramId}:
|
|
1364
|
+
patch:
|
|
1365
|
+
description: Update enablement program and task definition
|
|
1366
|
+
responses:
|
|
1367
|
+
'200':
|
|
1368
|
+
description: Success
|
|
1369
|
+
body:
|
|
1370
|
+
application/json:
|
|
1371
|
+
type: EnablementProgramRepresentation
|
|
1372
|
+
body:
|
|
1373
|
+
application/json:
|
|
1374
|
+
type: EnablementProgramInputRepresentation
|
|
1375
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1376
|
+
(oas-body-name): enablementProgram
|
|
1377
|
+
post:
|
|
1378
|
+
description: Creates Enablement Program and Enablement Task Definition
|
|
1379
|
+
responses:
|
|
1380
|
+
'200':
|
|
1381
|
+
description: Success
|
|
1382
|
+
body:
|
|
1383
|
+
application/json:
|
|
1384
|
+
type: EnablementProgramRepresentation
|
|
1385
|
+
body:
|
|
1386
|
+
application/json:
|
|
1387
|
+
type: EnablementProgramInputRepresentation
|
|
1388
|
+
#required: false # TODO hand rolled. W-11194242
|
|
1389
|
+
(oas-body-name): enablementProgram
|
|
1390
|
+
uriParameters:
|
|
1391
|
+
enablementProgramId:
|
|
1392
|
+
type: string
|
|
1393
|
+
required: true
|
|
1394
|
+
/{enablementProgramId}/describe:
|
|
1395
|
+
get:
|
|
1396
|
+
description: Describe Enablement Program
|
|
1397
|
+
responses:
|
|
1398
|
+
'200':
|
|
1399
|
+
description: Success
|
|
1400
|
+
body:
|
|
1401
|
+
application/json:
|
|
1402
|
+
type: EnablementProgramRepresentation
|
|
1403
|
+
uriParameters:
|
|
1404
|
+
enablementProgramId:
|
|
1405
|
+
type: string
|
|
1406
|
+
required: true
|