@salesforce/lds-adapters-cms-type 0.1.0-dev1

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.
Files changed (138) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/cms-type.js +368 -0
  3. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getContentType.d.ts +30 -0
  5. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +1 -0
  6. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +3 -0
  7. package/dist/es/es2018/types/src/generated/resources/deleteCmsDeploymentsByDeploymentId.d.ts +9 -0
  8. package/dist/es/es2018/types/src/generated/resources/deleteCmsSiteAuthorContentByContentKey.d.ts +14 -0
  9. package/dist/es/es2018/types/src/generated/resources/deleteConnectCmsContentJobsByJobId.d.ts +11 -0
  10. package/dist/es/es2018/types/src/generated/resources/deleteConnectCmsFoldersByFolderId.d.ts +11 -0
  11. package/dist/es/es2018/types/src/generated/resources/deleteConnectManagedContentContentSpacesContentsByContentSpaceIdAndManagedContentId.d.ts +10 -0
  12. package/dist/es/es2018/types/src/generated/resources/deleteConnectManagedContentContentSpacesMembersByContentSpaceIdAndMemberIdOrMe.d.ts +10 -0
  13. package/dist/es/es2018/types/src/generated/resources/getCmsContentsByContentKeyOrId.d.ts +18 -0
  14. package/dist/es/es2018/types/src/generated/resources/getCmsDeliveryCollectionByCollectionNameOrContentKeyAndTargetId.d.ts +21 -0
  15. package/dist/es/es2018/types/src/generated/resources/getCmsDeliveryCollectionMetadataByCollectionNameOrContentKeyAndTargetId.d.ts +19 -0
  16. package/dist/es/es2018/types/src/generated/resources/getCmsDeployments.d.ts +21 -0
  17. package/dist/es/es2018/types/src/generated/resources/getCmsSiteAuthorContentByContentKey.d.ts +18 -0
  18. package/dist/es/es2018/types/src/generated/resources/getCmsSiteAuthorContentContentKeys.d.ts +17 -0
  19. package/dist/es/es2018/types/src/generated/resources/getCmsSiteAuthorContentNodeByContentKeyAndContentNode.d.ts +16 -0
  20. package/dist/es/es2018/types/src/generated/resources/getCmsSiteAuthorContentNodesByContentKey.d.ts +18 -0
  21. package/dist/es/es2018/types/src/generated/resources/getCmsSpacesByContentSpaceId.d.ts +15 -0
  22. package/dist/es/es2018/types/src/generated/resources/getConnectCmsChannelsSearchableContentTypesByChannelId.d.ts +19 -0
  23. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContent.d.ts +16 -0
  24. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContentJobsByJobId.d.ts +15 -0
  25. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContentTypesByContentTypeFQN.d.ts +20 -0
  26. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContentVersionByManagedContentVersionId.d.ts +19 -0
  27. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContentsVariantsByVariantId.d.ts +15 -0
  28. package/dist/es/es2018/types/src/generated/resources/getConnectCmsFoldersByFolderId.d.ts +15 -0
  29. package/dist/es/es2018/types/src/generated/resources/getConnectCmsFoldersItemsByFolderId.d.ts +25 -0
  30. package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryByCommunityId.d.ts +25 -0
  31. package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryContentsByCommunityId.d.ts +27 -0
  32. package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryContentsSearchByCommunityId.d.ts +21 -0
  33. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentContentSpacesContentVersionsByContentSpaceIdAndManagedContentVersionId.d.ts +19 -0
  34. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentContentSpacesMembersByContentSpaceId.d.ts +15 -0
  35. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentContentSpacesMembersPermissionsByContentSpaceIdAndMemberIdOrMe.d.ts +16 -0
  36. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentRoles.d.ts +15 -0
  37. package/dist/es/es2018/types/src/generated/resources/patchConnectCmsChannelsSearchableContentTypesByChannelId.d.ts +13 -0
  38. package/dist/es/es2018/types/src/generated/resources/patchConnectCmsFoldersItemsByFolderId.d.ts +13 -0
  39. package/dist/es/es2018/types/src/generated/resources/patchConnectManagedContentContentSpacesContentsByContentSpaceIdAndManagedContentId.d.ts +14 -0
  40. package/dist/es/es2018/types/src/generated/resources/putConnectCmsContentsVariantsByVariantId.d.ts +16 -0
  41. package/dist/es/es2018/types/src/generated/types/AbstractMCSFolderRepresentation.d.ts +34 -0
  42. package/dist/es/es2018/types/src/generated/types/AbstractMContentRepresentation.d.ts +49 -0
  43. package/dist/es/es2018/types/src/generated/types/MCDeliveryV2VariantCollectionRepresentation.d.ts +29 -0
  44. package/dist/es/es2018/types/src/generated/types/MCDeliveryV2VariantInputRepresentation.d.ts +31 -0
  45. package/dist/es/es2018/types/src/generated/types/MCDeliveryV2VariantRepresentation.d.ts +52 -0
  46. package/dist/es/es2018/types/src/generated/types/MCSiteContentCollectionRepresentation.d.ts +29 -0
  47. package/dist/es/es2018/types/src/generated/types/MCSiteContentRepresentation.d.ts +45 -0
  48. package/dist/es/es2018/types/src/generated/types/MCSiteDeliveryByContentKeysInputRepresentation.d.ts +31 -0
  49. package/dist/es/es2018/types/src/generated/types/MCSiteDeliveryByContentTypesInputRepresentation.d.ts +28 -0
  50. package/dist/es/es2018/types/src/generated/types/MCSiteDeliveryByNodesInputRepresentation.d.ts +31 -0
  51. package/dist/es/es2018/types/src/generated/types/MCSiteNodeCollectionRepresentation.d.ts +29 -0
  52. package/dist/es/es2018/types/src/generated/types/MCSiteNodeRepresentation.d.ts +44 -0
  53. package/dist/es/es2018/types/src/generated/types/MCSiteVariantRepresentation.d.ts +46 -0
  54. package/dist/es/es2018/types/src/generated/types/MContentBodyRepresentation.d.ts +32 -0
  55. package/dist/es/es2018/types/src/generated/types/MContentCollectionMetadataRepresentation.d.ts +38 -0
  56. package/dist/es/es2018/types/src/generated/types/MContentCollectionRepresentation.d.ts +50 -0
  57. package/dist/es/es2018/types/src/generated/types/MContentDetailRepresentation.d.ts +30 -0
  58. package/dist/es/es2018/types/src/generated/types/MContentSummaryRepresentation.d.ts +26 -0
  59. package/dist/es/es2018/types/src/generated/types/ManagedContentAssociationsInputRep.d.ts +32 -0
  60. package/dist/es/es2018/types/src/generated/types/ManagedContentAssociationsRepresentation.d.ts +29 -0
  61. package/dist/es/es2018/types/src/generated/types/ManagedContentBodyInputRep.d.ts +32 -0
  62. package/dist/es/es2018/types/src/generated/types/ManagedContentChildRepresentation.d.ts +34 -0
  63. package/dist/es/es2018/types/src/generated/types/ManagedContentCollectionRepresentation.d.ts +29 -0
  64. package/dist/es/es2018/types/src/generated/types/ManagedContentDateAndTimeNodeValueRepresentation.d.ts +33 -0
  65. package/dist/es/es2018/types/src/generated/types/ManagedContentDateNodeValueRepresentation.d.ts +29 -0
  66. package/dist/es/es2018/types/src/generated/types/ManagedContentDeploymentCollectionRepresentation.d.ts +38 -0
  67. package/dist/es/es2018/types/src/generated/types/ManagedContentDeploymentInputRepresentation.d.ts +43 -0
  68. package/dist/es/es2018/types/src/generated/types/ManagedContentDeploymentItemRepresentation.d.ts +40 -0
  69. package/dist/es/es2018/types/src/generated/types/ManagedContentDeploymentRepresentation.d.ts +50 -0
  70. package/dist/es/es2018/types/src/generated/types/ManagedContentDetailCollectionRepresentation.d.ts +32 -0
  71. package/dist/es/es2018/types/src/generated/types/ManagedContentDetailRepresentation.d.ts +37 -0
  72. package/dist/es/es2018/types/src/generated/types/ManagedContentDocumentRepresentation.d.ts +76 -0
  73. package/dist/es/es2018/types/src/generated/types/ManagedContentExportContentJobRequestInputRepresentation.d.ts +43 -0
  74. package/dist/es/es2018/types/src/generated/types/ManagedContentExportJobItemIdsInputList.d.ts +28 -0
  75. package/dist/es/es2018/types/src/generated/types/ManagedContentFolderSummaryRepresentation.d.ts +31 -0
  76. package/dist/es/es2018/types/src/generated/types/ManagedContentInputRep.d.ts +31 -0
  77. package/dist/es/es2018/types/src/generated/types/ManagedContentInputRepresentation.d.ts +44 -0
  78. package/dist/es/es2018/types/src/generated/types/ManagedContentJobRepresentation.d.ts +64 -0
  79. package/dist/es/es2018/types/src/generated/types/ManagedContentJobRequestInputRepresentation.d.ts +40 -0
  80. package/dist/es/es2018/types/src/generated/types/ManagedContentMediaNodeValueRepresentation.d.ts +56 -0
  81. package/dist/es/es2018/types/src/generated/types/ManagedContentMediaSourceNodeValueRepresentation.d.ts +50 -0
  82. package/dist/es/es2018/types/src/generated/types/ManagedContentNodeTypeRepresentation.d.ts +34 -0
  83. package/dist/es/es2018/types/src/generated/types/ManagedContentNodeValueRepresentation.d.ts +33 -0
  84. package/dist/es/es2018/types/src/generated/types/ManagedContentRepresentation.d.ts +31 -0
  85. package/dist/es/es2018/types/src/generated/types/ManagedContentScheduleInputRepresentation.d.ts +46 -0
  86. package/dist/es/es2018/types/src/generated/types/ManagedContentSearchResultCollectionRepresentation.d.ts +38 -0
  87. package/dist/es/es2018/types/src/generated/types/ManagedContentSearchResultContentTypeRepresentation.d.ts +31 -0
  88. package/dist/es/es2018/types/src/generated/types/ManagedContentSearchResultRepresentation.d.ts +44 -0
  89. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderDetailRepresentation.d.ts +42 -0
  90. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderInputRep.d.ts +31 -0
  91. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderItemCollectionInputRep.d.ts +31 -0
  92. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderItemCollectionRepresentation.d.ts +35 -0
  93. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderItemRepresentation.d.ts +64 -0
  94. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderRepresentation.d.ts +26 -0
  95. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberCollectionRepresentation.d.ts +29 -0
  96. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberInputRepresentation.d.ts +31 -0
  97. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberPermissionsRepresentation.d.ts +37 -0
  98. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberRepresentation.d.ts +34 -0
  99. package/dist/es/es2018/types/src/generated/types/ManagedContentSpacePermissionRepresentation.d.ts +49 -0
  100. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceRepresentation.d.ts +55 -0
  101. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceRoleCollectionRepresentation.d.ts +29 -0
  102. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceRoleRepresentation.d.ts +34 -0
  103. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceSummaryRepresentation.d.ts +31 -0
  104. package/dist/es/es2018/types/src/generated/types/ManagedContentTextNodeValueRepresentation.d.ts +29 -0
  105. package/dist/es/es2018/types/src/generated/types/ManagedContentTranslationRepresentation.d.ts +64 -0
  106. package/dist/es/es2018/types/src/generated/types/ManagedContentTranslationRequestInputRep.d.ts +37 -0
  107. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeRepresentation.d.ts +39 -0
  108. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSchemaRepresentation.d.ts +49 -0
  109. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSearchableCollectionRepresentation.d.ts +38 -0
  110. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSearchableInputRepresentation.d.ts +31 -0
  111. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSearchableRepresentation.d.ts +37 -0
  112. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSummaryRepresentation.d.ts +31 -0
  113. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeViewRepresentation.d.ts +38 -0
  114. package/dist/es/es2018/types/src/generated/types/ManagedContentUserSummaryRepresentation.d.ts +31 -0
  115. package/dist/es/es2018/types/src/generated/types/ManagedContentVariantRepresentation.d.ts +78 -0
  116. package/dist/es/es2018/types/src/generated/types/ManagedContentVariantUpdateInputRepresentation.d.ts +38 -0
  117. package/dist/es/es2018/types/src/generated/types/ManagedContentVariantV1InputRep.d.ts +46 -0
  118. package/dist/es/es2018/types/src/generated/types/ManagedContentVariantV1Representation.d.ts +49 -0
  119. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionCollectionRepresentation.d.ts +49 -0
  120. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionInputRep.d.ts +50 -0
  121. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionInternalCollectionRepresentation.d.ts +32 -0
  122. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionInternalRepresentation.d.ts +80 -0
  123. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionRepresentation.d.ts +65 -0
  124. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionSiteNodeCollectionRepresentation.d.ts +29 -0
  125. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionSiteNodeRepresentation.d.ts +40 -0
  126. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2CollectionInputRepresentation.d.ts +28 -0
  127. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2CollectionRepresentation.d.ts +32 -0
  128. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2InputRepresentation.d.ts +53 -0
  129. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2Representation.d.ts +74 -0
  130. package/dist/es/es2018/types/src/generated/types/ReferenceRepresentation.d.ts +31 -0
  131. package/dist/es/es2018/types/src/generated/types/StreamedRepresentation.d.ts +25 -0
  132. package/dist/es/es2018/types/src/generated/types/TopicSummaryRepresentation.d.ts +31 -0
  133. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  134. package/package.json +75 -0
  135. package/sfdc/index.d.ts +1 -0
  136. package/sfdc/index.js +399 -0
  137. package/src/raml/api.raml +2924 -0
  138. package/src/raml/luvio.raml +17 -0
@@ -0,0 +1,2924 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '53.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v66.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
+ AbstractMCSFolderRepresentation:
29
+ description: Abstract Representation of a CMS Folder i.e. ManagedContentSpaceFolder
30
+ having only Id, Name, ParentFolderId
31
+ discriminator: id # TODO: hand rolled
32
+ type: object
33
+ properties:
34
+ id:
35
+ description: The ID of the folder - ManagedContentSpaceFolder
36
+ type: string
37
+ name:
38
+ description: The name of the folder
39
+ type: string
40
+ parentFolderId:
41
+ description: The ID of the folder's parent
42
+ type: string
43
+ AbstractMContentRepresentation:
44
+ description: Compact information about a content.
45
+ discriminator: contentKey # TODO: hand rolled
46
+ type: object
47
+ properties:
48
+ contentKey:
49
+ description: The content key
50
+ type: string
51
+ contentUrlName:
52
+ description: The content url name of the managed content version.
53
+ type: string
54
+ language:
55
+ description: The language of the managed content version.
56
+ type: string
57
+ managedContentId:
58
+ description: The unique identifier of the managed content in the authoring
59
+ space.
60
+ type: string
61
+ publishedDate:
62
+ description: Get the date when the managed content version was last published.
63
+ type: string
64
+ title:
65
+ description: Get the title of the managed content version.
66
+ type: string
67
+ type:
68
+ description: The type of the managed content version.
69
+ type: string
70
+ typeLabel:
71
+ description: The type label of the managed content type.
72
+ type: string
73
+ MCDeliveryV2VariantCollectionRepresentation:
74
+ description: The collection representing the list of managed content variant information
75
+ type: object
76
+ properties:
77
+ variants:
78
+ description: List of all variants
79
+ type: array
80
+ items:
81
+ type: MCDeliveryV2VariantRepresentation
82
+ MCDeliveryV2VariantInputRepresentation:
83
+ description: Input representation to get variants by content ids and variant key
84
+ type: object
85
+ properties:
86
+ contentIds:
87
+ description: List of contentIds to filter variants
88
+ type: array
89
+ items:
90
+ type: string
91
+ variantKey:
92
+ description: Variant Key to filter variants
93
+ type: string
94
+ MCDeliveryV2VariantRepresentation:
95
+ description: The output representation of a managed content variant detailed information
96
+ type: object
97
+ properties:
98
+ contentKey:
99
+ description: Content Key of the content
100
+ type: string
101
+ contentType:
102
+ description: Content type of the content
103
+ type: string
104
+ language:
105
+ description: Language of the variant
106
+ type: string
107
+ lastUpdatedBy:
108
+ description: Last updated by (user id) of the variant
109
+ type: string
110
+ managedContentId:
111
+ description: Id of the Managed Content
112
+ type: string
113
+ publishedDate:
114
+ description: Published Date of the variant
115
+ type: string
116
+ title:
117
+ description: Title of the variant
118
+ type: string
119
+ urlName:
120
+ description: UrlName of the variant
121
+ type: string
122
+ variantKey:
123
+ description: Variant Key of the variant
124
+ type: string
125
+ MCSiteContentCollectionRepresentation:
126
+ description: The collection representing the list of managed content detailed
127
+ information
128
+ type: object
129
+ properties:
130
+ contents:
131
+ description: List of all contents delivered to a site
132
+ type: array
133
+ items:
134
+ type: MCSiteContentRepresentation
135
+ MCSiteContentRepresentation:
136
+ description: The output representation of a managed content detailed information
137
+ type: object
138
+ properties:
139
+ children:
140
+ description: List of all immediate children of this content
141
+ type: array
142
+ items:
143
+ type: ManagedContentChildRepresentation
144
+ contentKey:
145
+ description: Content key of a Managed Content
146
+ type: string
147
+ contentType:
148
+ description: Type of a Managed Content
149
+ type: string
150
+ managedContentId:
151
+ description: Id of a Managed Content
152
+ type: string
153
+ parentContentKey:
154
+ description: Parent's Content key
155
+ type: string
156
+ variants:
157
+ description: List of variants of this content delivered
158
+ type: array
159
+ items:
160
+ type: MCSiteVariantRepresentation
161
+ MCSiteDeliveryByContentKeysInputRepresentation:
162
+ description: Input representation to fetch content by content keys
163
+ type: object
164
+ properties:
165
+ contentKeys:
166
+ description: List of Content keys to filter contents
167
+ type: array
168
+ items:
169
+ type: string
170
+ includeChildren:
171
+ description: Should include immediate children or not
172
+ type: boolean
173
+ MCSiteDeliveryByContentTypesInputRepresentation:
174
+ description: Input representation to fetch content by content types
175
+ type: object
176
+ properties:
177
+ contentTypes:
178
+ description: List of Content types to filter contents
179
+ type: array
180
+ items:
181
+ type: string
182
+ MCSiteDeliveryByNodesInputRepresentation:
183
+ description: Input representation to fetch content by content types
184
+ type: object
185
+ properties:
186
+ contentKey:
187
+ description: content key for a content to fetch nodes
188
+ type: string
189
+ nodeIds:
190
+ description: List of node Ids to filter from content
191
+ type: array
192
+ items:
193
+ type: string
194
+ MCSiteNodeCollectionRepresentation:
195
+ description: A list of node representations of a content
196
+ type: object
197
+ properties:
198
+ nodes:
199
+ description: List of nodes
200
+ type: array
201
+ items:
202
+ type: MCSiteNodeRepresentation
203
+ MCSiteNodeRepresentation:
204
+ description: The node representation of a content
205
+ type: object
206
+ properties:
207
+ contentKey:
208
+ description: Content key of a Managed Content
209
+ type: string
210
+ lastModifiedBy:
211
+ description: last modified by user of variant
212
+ type: string
213
+ nodes:
214
+ description: Map of variant key to node body
215
+ type: object
216
+ properties:
217
+ //:
218
+ type: string
219
+ publishDate:
220
+ description: published date of variant
221
+ type: string
222
+ variantKey:
223
+ description: variant key of a variant
224
+ type: string
225
+ MCSiteVariantRepresentation:
226
+ description: The variant representation of a content
227
+ type: object
228
+ properties:
229
+ body:
230
+ description: body of the variant delivered to a site
231
+ type: string
232
+ language:
233
+ description: language of the variant delivered to a site
234
+ type: string
235
+ lastUpdatedBy:
236
+ description: Last updated by user id of the variant delivered to a site
237
+ type: string
238
+ publishedDate:
239
+ description: published date of the variant delivered to a site
240
+ type: string
241
+ title:
242
+ description: title of the variant delivered to a site
243
+ type: string
244
+ urlName:
245
+ description: urlname/slug of the variant delivered to a site
246
+ type: string
247
+ variantKey:
248
+ description: Variant key of the variant delivered to a site
249
+ type: string
250
+ MContentBodyRepresentation:
251
+ description: Information about a managed content version.
252
+ type: object
253
+ properties:
254
+ body:
255
+ description: Content Body.
256
+ type: object
257
+ properties:
258
+ //:
259
+ type: object
260
+ MContentCollectionMetadataRepresentation:
261
+ description: Collection details.
262
+ type: object
263
+ properties:
264
+ description:
265
+ description: Decription of the collection schema.
266
+ type: string
267
+ schema:
268
+ description: Schema of the collection type.
269
+ type: object
270
+ properties:
271
+ //:
272
+ type: object
273
+ title:
274
+ description: Title of the collection schema.
275
+ type: string
276
+ MContentCollectionRepresentation:
277
+ description: Collection details.
278
+ type: object
279
+ properties:
280
+ contentKey:
281
+ description: The content key
282
+ type: string
283
+ currentPageUrl:
284
+ description: URL to the current page of collection details. The default is
285
+ 25 managed content versions per page.
286
+ type: string
287
+ description:
288
+ description: Decription of the collection.
289
+ type: string
290
+ items:
291
+ description: Managed content versions for this page.
292
+ type: array
293
+ items:
294
+ type: MContentDetailRepresentation
295
+ nextPageUrl:
296
+ description: URL to the next page of managed content versions, The default
297
+ is 25 managed content versions per page.
298
+ type: string
299
+ title:
300
+ description: Title of the collection.
301
+ type: string
302
+ total:
303
+ description: Total number of versions across all pages.
304
+ type: integer
305
+ type:
306
+ description: Type of the collection.
307
+ type: string
308
+ MContentDetailRepresentation:
309
+ description: Full information about a single content.
310
+ type: AbstractMContentRepresentation
311
+ properties:
312
+ contentBody:
313
+ description: Get the content body
314
+ type: MContentBodyRepresentation
315
+ MContentSummaryRepresentation:
316
+ description: Compact information about a content.
317
+ type: AbstractMContentRepresentation
318
+ properties: {}
319
+ ManagedContentAssociationsInputRep:
320
+ description: "Input Representation for associations for managed content. Describes\
321
+ \ how \n * a ManagedContent is organized. Examples are the list of topics that\
322
+ \ are \n * assigned to a ManagedContent and the folders in which the ManagedContent\
323
+ \ is placed. "
324
+ type: object
325
+ properties:
326
+ topics:
327
+ description: The names of topics to associate the Managed Content with. Set
328
+ to empty to remove all topic associations from the Managed Content.
329
+ type: array
330
+ items:
331
+ type: string
332
+ ManagedContentAssociationsRepresentation:
333
+ description: The Managed Content Associations, e.g. topic associations, describing
334
+ how this Managed Content is organized and discoverable
335
+ type: object
336
+ properties:
337
+ topics:
338
+ description: A collection of topics associated with this Managed Content.
339
+ type: array
340
+ items:
341
+ type: TopicSummaryRepresentation
342
+ ManagedContentBodyInputRep:
343
+ description: Input representation for the body of a managed content.
344
+ type: object
345
+ properties:
346
+ nodeMap:
347
+ description: The body of the managed content version.
348
+ type: object
349
+ properties:
350
+ //:
351
+ type: object
352
+ ManagedContentChildRepresentation:
353
+ description: The representation of a child managed content
354
+ type: object
355
+ properties:
356
+ contentKey:
357
+ description: Content key of a Managed Content
358
+ type: string
359
+ contentType:
360
+ description: Type of a Managed Content
361
+ type: string
362
+ managedContentId:
363
+ description: Id of a Managed Content
364
+ type: string
365
+ ManagedContentCollectionRepresentation:
366
+ description: The output representation of a list of contents
367
+ type: object
368
+ properties:
369
+ contents:
370
+ description: List of contents
371
+ type: array
372
+ items:
373
+ type: ManagedContentRepresentation
374
+ ManagedContentDateAndTimeNodeValueRepresentation:
375
+ description: Information about a managed content node of datetime type.
376
+ discriminatorValue: Date # TODO: hand rolled
377
+ type: ManagedContentNodeValueRepresentation
378
+ properties:
379
+ dateTimeValue:
380
+ description: The DateTime value in UTC of the managed content node.
381
+ type: string
382
+ timeZone:
383
+ description: The TimeZone in which DateTime is authored of the managed content
384
+ node.
385
+ type: string
386
+ ManagedContentDateNodeValueRepresentation:
387
+ description: Information about a managed content node of type date.
388
+ type: ManagedContentNodeValueRepresentation
389
+ properties:
390
+ value:
391
+ description: The date value of the managed content node.
392
+ type: string
393
+ ManagedContentDeploymentCollectionRepresentation:
394
+ description: Collection of Deployments
395
+ type: object
396
+ properties:
397
+ currentPageUrl:
398
+ description: URL to the current page of Manage Content deployment records.
399
+ type: string
400
+ deployments:
401
+ description: ManagedContentDeployment collection
402
+ type: array
403
+ items:
404
+ type: ManagedContentDeploymentRepresentation
405
+ nextPageUrl:
406
+ description: URL to the next page of Manage Content deployment records.
407
+ type: string
408
+ previousPageUrl:
409
+ description: URL to the previous page of Managed Content deployment records.
410
+ type: string
411
+ ManagedContentDeploymentInputRepresentation:
412
+ description: Input required for creating a deployment
413
+ type: object
414
+ properties:
415
+ channelIds:
416
+ description: '[Optional] The target channel to publish content to.'
417
+ type: array
418
+ items:
419
+ type: string
420
+ contentIds:
421
+ description: '[Optional] The content to publish.'
422
+ type: array
423
+ items:
424
+ type: string
425
+ contentSpaceId:
426
+ description: The content space to publish content from.
427
+ type: string
428
+ description:
429
+ description: Description for deployment.
430
+ type: string
431
+ executeStagedDeployments:
432
+ description: '[Optional] Execute all staged deployments.'
433
+ type: boolean
434
+ scheduledDate:
435
+ description: '[Optional] Scheduled date for deployment.'
436
+ type: string
437
+ ManagedContentDeploymentItemRepresentation:
438
+ description: Information about a deploymentItem
439
+ type: object
440
+ properties:
441
+ action:
442
+ description: Action for the ITEM
443
+ type: string
444
+ deploymentId:
445
+ description: ManagedContentDeployment Entity Id
446
+ type: string
447
+ deploymentItemId:
448
+ description: ManagedContentDeploymentItem Entity Id
449
+ type: string
450
+ snapshotId:
451
+ description: Snapshot Entity Id
452
+ type: string
453
+ targetId:
454
+ description: Target Entity Id
455
+ type: string | nil
456
+ ManagedContentDeploymentRepresentation:
457
+ description: Information about a Deployment
458
+ type: object
459
+ properties:
460
+ createdBy:
461
+ description: ManagedContentDeployment record creator user Id
462
+ type: string | nil
463
+ deploymentDescription:
464
+ description: ManagedContentDeployment Description
465
+ type: string | nil
466
+ deploymentId:
467
+ description: ManagedContentDeployment Entity Id
468
+ type: string
469
+ deploymentItems:
470
+ description: ManagedContentDeploymentItem list
471
+ type: array
472
+ items:
473
+ type: ManagedContentDeploymentItemRepresentation
474
+ deploymentName:
475
+ description: ManagedContentDeployment Name
476
+ type: string | nil
477
+ deploymentStatus:
478
+ description: ManagedContentDeployment Status
479
+ type: string | nil
480
+ lastModifiedBy:
481
+ description: ManagedContentDeployment record Last Modified user Id
482
+ type: string | nil
483
+ scheduledDate:
484
+ description: ManagedContentDeployment Scheduled Date
485
+ type: string | nil
486
+ ManagedContentDetailCollectionRepresentation:
487
+ description: Collection of ManagedContentDetailCollection
488
+ type: object
489
+ properties:
490
+ managedContentRecords:
491
+ description: Managed Content Details
492
+ type: array
493
+ items:
494
+ type: ManagedContentDetailRepresentation
495
+ totalItem:
496
+ description: Total count of records
497
+ type: integer
498
+ ManagedContentDetailRepresentation:
499
+ description: Details of a Managed Content
500
+ type: object
501
+ properties:
502
+ contentKey:
503
+ description: Content Key
504
+ type: string
505
+ managedContentId:
506
+ description: Id of the Managed Content
507
+ type: string
508
+ managedContentSpaceId:
509
+ description: Id Managed Content Space
510
+ type: string
511
+ managedContentVersionId:
512
+ description: Id of the Managed Content Version
513
+ type: string
514
+ ManagedContentDocumentRepresentation:
515
+ description: Information about a managed content in authoring space.
516
+ type: object
517
+ properties:
518
+ apiName:
519
+ description: The api name of the managed content.
520
+ type: string | nil
521
+ required: false
522
+ contentBody:
523
+ description: Body contains fields defined in the managed content type schema
524
+ of this managed content.
525
+ type: object
526
+ properties:
527
+ //:
528
+ type: object
529
+ contentKey:
530
+ description: Globally unique identifier of a managed content and doesn't change
531
+ when managed content is moved between production and sandbox environments.
532
+ type: string
533
+ contentSpace:
534
+ description: The content space of the managed content.
535
+ type: ManagedContentSpaceSummaryRepresentation
536
+ contentType:
537
+ description: The type of the managed content.
538
+ type: ManagedContentTypeSummaryRepresentation
539
+ createdBy:
540
+ description: The user who created the managed content.
541
+ type: ManagedContentUserSummaryRepresentation
542
+ createdDate:
543
+ description: The created date of the managed content.
544
+ type: string
545
+ folder:
546
+ description: The content folder of the managed content.
547
+ type: ManagedContentFolderSummaryRepresentation
548
+ language:
549
+ description: The language of the managed content.
550
+ type: string
551
+ lastModifiedBy:
552
+ description: The last user who has modified the managed content.
553
+ type: ManagedContentUserSummaryRepresentation
554
+ lastModifiedDate:
555
+ description: The last time the managed content has been modified.
556
+ type: string
557
+ managedContentId:
558
+ description: Id of the managed content in authoring space.
559
+ type: string
560
+ managedContentVariantId:
561
+ description: The managed content variant in the authoring space.
562
+ type: string
563
+ managedContentVersionId:
564
+ description: Version id of the managed content version.
565
+ type: string
566
+ title:
567
+ description: The title of the managed content.
568
+ type: string
569
+ urlName:
570
+ description: The content url name of the managed content.
571
+ type: string
572
+ ManagedContentExportContentJobRequestInputRepresentation:
573
+ description: Input representation for creating a ManagedContent export job
574
+ type: object
575
+ properties:
576
+ contentSpaceId:
577
+ description: Managed Content Space Id
578
+ type: string
579
+ folderIds:
580
+ description: Collection of managed Content folder Ids
581
+ type: array
582
+ items:
583
+ type: string
584
+ includeReferenceContent:
585
+ description: The indicator to export the referenced content
586
+ type: boolean
587
+ managedContentIds:
588
+ description: Collection of managed Content Ids
589
+ type: array
590
+ items:
591
+ type: string
592
+ name:
593
+ description: Managed Content Export Job Name
594
+ type: string
595
+ parentFolderId:
596
+ description: Parent FolderId of Managed Content Export data
597
+ type: string
598
+ ManagedContentExportJobItemIdsInputList:
599
+ description: ManagedContentExportJobItemIdsInputRepresentation list object
600
+ type: object
601
+ properties:
602
+ ids:
603
+ description: The id value.
604
+ type: array
605
+ items:
606
+ type: string
607
+ ManagedContentFolderSummaryRepresentation:
608
+ description: Information about a managed content folder.
609
+ type: object
610
+ properties:
611
+ id:
612
+ description: Id of the managed content folder in the authoring space.
613
+ type: string
614
+ resourceUrl:
615
+ description: Connect API resource url to get more information about managed
616
+ content folder.
617
+ type: string
618
+ ManagedContentInputRep:
619
+ description: Input representation for a managed content
620
+ type: object
621
+ properties:
622
+ connectManagedContentStatusEnum:
623
+ description: The published status the user wants to patch the latest version
624
+ the content to
625
+ type: string
626
+ publishedVersionId:
627
+ description: The published version id of the managed content.
628
+ type: string
629
+ ManagedContentInputRepresentation:
630
+ description: 'Input representation for a managed content '
631
+ type: object
632
+ properties:
633
+ contentBody:
634
+ description: The body of the managed content.
635
+ type: object
636
+ properties:
637
+ //:
638
+ type: object
639
+ contentSpaceOrFolderId:
640
+ description: Content space or folder id where content will be created.
641
+ type: string
642
+ contentType:
643
+ description: Fully qualified name of the content type to create. This field
644
+ is required.
645
+ type: string
646
+ title:
647
+ description: The title of the managed content.
648
+ type: string
649
+ urlName:
650
+ description: URL-friendly identifier of the content within the org.
651
+ type: string
652
+ ManagedContentJobRepresentation:
653
+ description: Information about a managed content import/export job
654
+ type: object
655
+ properties:
656
+ createdBy:
657
+ description: The user id who created the managed content job
658
+ type: string
659
+ createdDate:
660
+ description: The created date of the managed content job
661
+ type: string
662
+ errorBodyUrl:
663
+ description: The URL to get the error content body of a managed content job
664
+ type: string
665
+ id:
666
+ description: The id of a managed content job
667
+ type: string
668
+ inputBodyUrl:
669
+ description: The URL to get the input content body of a managed content job
670
+ type: string
671
+ jobType:
672
+ description: The type of a managed content job
673
+ type: string
674
+ enum:
675
+ - Export
676
+ - Import
677
+ lastModifiedBy:
678
+ description: The last user id who has modified the managed content job
679
+ type: string
680
+ lastModifiedDate:
681
+ description: The last time the managed content job has been modified
682
+ type: string
683
+ lastStatusUpdateDate:
684
+ description: The last status update date of a managed content job
685
+ type: string
686
+ name:
687
+ description: The name of a managed content job
688
+ type: string
689
+ outputBodyUrl:
690
+ description: The URL to get the output content body of a managed content job
691
+ type: string
692
+ startDate:
693
+ description: The start date of a managed content job
694
+ type: string
695
+ status:
696
+ description: The status of a managed content job
697
+ type: string
698
+ enum:
699
+ - Completed
700
+ - CompletedWithError
701
+ - Created
702
+ - Failed
703
+ - Pending
704
+ - Processing
705
+ ManagedContentJobRequestInputRepresentation:
706
+ description: Input representation for creating a ManagedContent import/export
707
+ job
708
+ type: object
709
+ properties:
710
+ autoPublish:
711
+ description: Auto publish the data after import if that operation is permitted
712
+ type: boolean
713
+ contentBodyId:
714
+ description: ContentBody Id of Managed Content Import data
715
+ type: string
716
+ contentSpaceId:
717
+ description: Managed Content Space Id
718
+ type: string
719
+ includeContentKey:
720
+ description: Update existing content after importing data if it exists by
721
+ including content key; Otherwise create new content
722
+ type: boolean
723
+ name:
724
+ description: Managed Content Job Name
725
+ type: string
726
+ ManagedContentMediaNodeValueRepresentation:
727
+ description: Information about a managed content node of media type.
728
+ type: ManagedContentNodeValueRepresentation
729
+ properties:
730
+ altText:
731
+ description: The alternate text for the managed content node.
732
+ type: string
733
+ contentKey:
734
+ description: The contentKey of managed content being referenced.
735
+ type: string
736
+ fileName:
737
+ description: The file name of the managed content node.
738
+ type: string
739
+ mediaType:
740
+ description: The media type of the managed content node like Image, Video
741
+ or Document
742
+ type: string
743
+ enum:
744
+ - Document
745
+ - Image
746
+ - Video
747
+ mimeType:
748
+ description: The mime type of the managed content node.
749
+ type: string
750
+ resourceUrl:
751
+ description: The resource url of the managed content node.
752
+ type: string
753
+ thumbnailUrl:
754
+ description: Media thumbnail url.
755
+ type: string
756
+ title:
757
+ description: The title of the managed content node.
758
+ type: string
759
+ unauthenticatedUrl:
760
+ description: The unauthenticated url of the managed content node.
761
+ type: string
762
+ url:
763
+ description: The url of the managed content node.
764
+ type: string
765
+ ManagedContentMediaSourceNodeValueRepresentation:
766
+ description: Information about a source of a managed content media.
767
+ type: ManagedContentNodeValueRepresentation
768
+ properties:
769
+ fileName:
770
+ description: The file name of the media source.
771
+ type: string
772
+ isExternal:
773
+ description: Whether media source is uploaded or referenced via external url.
774
+ type: boolean
775
+ mediaType:
776
+ description: The type of media like Image, Video or Document.
777
+ type: string
778
+ enum:
779
+ - Document
780
+ - Image
781
+ - Video
782
+ mimeType:
783
+ description: The mime type of the media source.
784
+ type: string
785
+ referenceId:
786
+ description: Reference id of the uploaded media source
787
+ type: string
788
+ resourceUrl:
789
+ description: The API url to the bytes of the media source.
790
+ type: string
791
+ unauthenticatedUrl:
792
+ description: The url to the bytes of the media source for unauthenticated
793
+ users.
794
+ type: string
795
+ url:
796
+ description: The url to the bytes of the source for authenticated users.
797
+ type: string
798
+ ManagedContentNodeTypeRepresentation:
799
+ description: Information about a managed content node type.
800
+ type: object
801
+ properties:
802
+ label:
803
+ description: The label of the managed content node type.
804
+ type: string
805
+ name:
806
+ description: The developer name of the managed content node type.
807
+ type: string
808
+ nodeType:
809
+ description: The type of the managed content node.
810
+ type: string
811
+ enum:
812
+ - Date
813
+ - DateTime
814
+ - Media
815
+ - MediaSource
816
+ - MultilineText
817
+ - NameField
818
+ - RichText
819
+ - Text
820
+ - Url
821
+ ManagedContentNodeValueRepresentation:
822
+ description: Information about a managed content node.
823
+ discriminator: nodeType # TODO: hand rolled
824
+ type: object
825
+ properties:
826
+ nodeType:
827
+ description: The type of the managed content node.
828
+ type: string
829
+ enum:
830
+ - Date
831
+ - DateTime
832
+ - Media
833
+ - MediaSource
834
+ - MultilineText
835
+ - NameField
836
+ - RichText
837
+ - Text
838
+ - Url
839
+ ManagedContentRepresentation:
840
+ description: The output representation of a managed content
841
+ type: object
842
+ properties:
843
+ contentKey:
844
+ description: Content key of a Managed Content
845
+ type: string
846
+ contentType:
847
+ description: Content type of a Managed Content
848
+ type: string
849
+ ManagedContentScheduleInputRepresentation:
850
+ description: Input required for creating a scheduled deployment in 232
851
+ type: object
852
+ properties:
853
+ action:
854
+ description: Action can be Publish/Unpublish for deployment
855
+ type: string
856
+ enum:
857
+ - Publish
858
+ - Unpublish
859
+ authorSpaceId:
860
+ description: Authoring managed content space id where the deployment will
861
+ be scheduled
862
+ type: string
863
+ description:
864
+ description: Name of the deployment
865
+ type: string
866
+ expireDate:
867
+ description: Expiry date of the schedule
868
+ type: string
869
+ publishContentReference:
870
+ description: PublishContentReference will help publish the reference item
871
+ type: boolean
872
+ scheduleDate:
873
+ description: Setting the schedule date for the deployment
874
+ type: string
875
+ versionIds:
876
+ description: For unpublish we need to set the versionIds
877
+ type: array
878
+ items:
879
+ type: string
880
+ ManagedContentSearchResultCollectionRepresentation:
881
+ description: A container of paginated cms keyword-based search result items plus
882
+ a short search result summary
883
+ type: object
884
+ properties:
885
+ count:
886
+ description: total search result item count
887
+ type: integer
888
+ currentPageUri:
889
+ description: search result URI
890
+ type: string
891
+ items:
892
+ description: an array of search result items
893
+ type: array
894
+ items:
895
+ type: ManagedContentSearchResultRepresentation
896
+ nextPageUri:
897
+ description: next search result URI
898
+ type: string
899
+ ManagedContentSearchResultContentTypeRepresentation:
900
+ description: A keyword-based search result item's content type
901
+ type: object
902
+ properties:
903
+ developerName:
904
+ description: managed content type developer name
905
+ type: string
906
+ label:
907
+ description: managed content type label
908
+ type: string
909
+ ManagedContentSearchResultRepresentation:
910
+ description: A keyword-based search result item
911
+ type: object
912
+ properties:
913
+ contentKey:
914
+ description: managed content content key
915
+ type: string
916
+ contentType:
917
+ description: managed content content type
918
+ type: ManagedContentSearchResultContentTypeRepresentation
919
+ id:
920
+ description: managed content id
921
+ type: string
922
+ publishDate:
923
+ description: managed content published date
924
+ type: string
925
+ title:
926
+ description: managed content title
927
+ type: string
928
+ urlName:
929
+ description: managed content (version) url name
930
+ type: string
931
+ ManagedContentSpaceFolderDetailRepresentation:
932
+ description: Detail Representation of a CMS Folder i.e. ManagedContentSpaceFolder
933
+ type: AbstractMCSFolderRepresentation
934
+ properties:
935
+ createdBy:
936
+ description: The User ID of the user who created the folder
937
+ type: string
938
+ createdDate:
939
+ description: The date when the folder was created
940
+ type: string
941
+ folderHierarchy:
942
+ description: The list of the parent folders in the hierarchy - starting from
943
+ the root upto the direct parent of the folder
944
+ type: array
945
+ items:
946
+ type: ManagedContentSpaceFolderRepresentation
947
+ lastModifiedBy:
948
+ description: The User ID of the user who last modified the folder
949
+ type: string
950
+ lastModifiedDate:
951
+ description: The date when the folder was last modified
952
+ type: string
953
+ ManagedContentSpaceFolderInputRep:
954
+ description: Input representation of a content space folder
955
+ type: object
956
+ properties:
957
+ name:
958
+ description: The name of the folder
959
+ type: string
960
+ parentFolderId:
961
+ description: Parent folder id
962
+ type: string
963
+ ManagedContentSpaceFolderItemCollectionInputRep:
964
+ description: Collection input of ManagedContentSpaceFolderItems for Move operation
965
+ type: object
966
+ properties:
967
+ folderId:
968
+ description: ID of the new parent folder to the items should be moved
969
+ type: string
970
+ folderItems:
971
+ description: List of IDs of the folder items that need to be moved
972
+ type: array
973
+ items:
974
+ type: string
975
+ ManagedContentSpaceFolderItemCollectionRepresentation:
976
+ description: Collection Representation of folder items inside in ManagedContentSpaceFolder
977
+ type: object
978
+ properties:
979
+ folderId:
980
+ description: The id of the folder
981
+ type: string
982
+ folderItems:
983
+ description: The list of the folder items - ManagedContent or ManagedContentSpaceFolder
984
+ type: array
985
+ items:
986
+ type: ManagedContentSpaceFolderItemRepresentation
987
+ parentFolderId:
988
+ description: The id of the parent folder
989
+ type: string
990
+ ManagedContentSpaceFolderItemRepresentation:
991
+ description: Representation of a folder item inside a ManagedContentSpaceFolder
992
+ type: object
993
+ properties:
994
+ contentKey:
995
+ description: The ContentKey of the ManagedContent
996
+ type: string
997
+ createdBy:
998
+ description: The User ID for the user which created the ManagedContent or
999
+ ManagedContentSpaceFolder
1000
+ type: string
1001
+ createdDate:
1002
+ description: The date when the ManagedContent or ManagedContentSpaceFolder
1003
+ was created
1004
+ type: string
1005
+ hasChildFolders:
1006
+ description: Boolean flag to indicate whether this folder has child folders
1007
+ type: boolean
1008
+ id:
1009
+ description: The id of the folder item - ManagedContent or ManagedContentSpaceFolder
1010
+ type: string
1011
+ isFolder:
1012
+ description: Boolean flag to indicate whether this folder item is a folder
1013
+ type: boolean
1014
+ lastModifiedBy:
1015
+ description: The User ID for the user which last modified the ManagedContent
1016
+ or ManagedContentSpaceFolder
1017
+ type: string
1018
+ lastModifiedDate:
1019
+ description: The date when the ManagedContent or ManagedContentSpaceFolder
1020
+ was last modified
1021
+ type: string
1022
+ managedContentType:
1023
+ description: Developer Name for the ManagedContentType if the folder item
1024
+ is ManagedContent
1025
+ type: string
1026
+ managedContentVersionId:
1027
+ description: Latest Managed Content Version Id of the folder item is ManagedContent
1028
+ type: string
1029
+ publishedDate:
1030
+ description: Date when the ManagedContent was last published
1031
+ type: string
1032
+ status:
1033
+ description: Status of the Managed Content
1034
+ type: string
1035
+ title:
1036
+ description: Title of the ManagedContent/ManagedContentSpaceFolder
1037
+ type: string
1038
+ ManagedContentSpaceFolderRepresentation:
1039
+ description: Base Representation of a CMS Folder i.e. ManagedContentSpaceFolder
1040
+ type: AbstractMCSFolderRepresentation
1041
+ properties: {}
1042
+ ManagedContentSpaceMemberCollectionRepresentation:
1043
+ description: Collection representation of the members in a content space
1044
+ type: object
1045
+ properties:
1046
+ members:
1047
+ description: List of the members in the content space
1048
+ type: array
1049
+ items:
1050
+ type: ManagedContentSpaceMemberRepresentation
1051
+ ManagedContentSpaceMemberInputRepresentation:
1052
+ description: Input representation of a content space member
1053
+ type: object
1054
+ properties:
1055
+ memberId:
1056
+ description: The ID of the user/group to assign the role in the content space
1057
+ type: string
1058
+ roleId:
1059
+ description: The ID of the role to assign the user as, in the content space
1060
+ type: string
1061
+ ManagedContentSpaceMemberPermissionsRepresentation:
1062
+ description: Representation of permissions of a member in a content space
1063
+ type: object
1064
+ properties:
1065
+ permissions:
1066
+ description: A map of permissions for a member grouped by different scopes
1067
+ and consequently spaceContentTypes
1068
+ type: object
1069
+ properties:
1070
+ //:
1071
+ type: object
1072
+ properties:
1073
+ //:
1074
+ type: ManagedContentSpacePermissionRepresentation
1075
+ ManagedContentSpaceMemberRepresentation:
1076
+ description: Representation of a ManagedContentSpaceMember
1077
+ type: object
1078
+ properties:
1079
+ id:
1080
+ description: The id of managedContentSpaceMember entity object
1081
+ type: string
1082
+ memberId:
1083
+ description: The user / group id
1084
+ type: string
1085
+ role:
1086
+ description: The role associated with the member
1087
+ type: ManagedContentSpaceRoleRepresentation
1088
+ ManagedContentSpacePermissionRepresentation:
1089
+ description: Representation of a permission bit vector based on a scopeType or
1090
+ contentTypeIdOrEnum
1091
+ type: object
1092
+ properties:
1093
+ canCreate:
1094
+ description: Does the member have create access for the scopeType and spaceContentType
1095
+ type: boolean
1096
+ canDelete:
1097
+ description: Does the member have delete access for the scopeType and spaceContentType
1098
+ type: boolean
1099
+ canManage:
1100
+ description: Does the member have manage access for the scopeType and spaceContentType
1101
+ type: boolean
1102
+ canPublish:
1103
+ description: Does the member have publish/unpublish access for the scopeType
1104
+ and spaceContentType
1105
+ type: boolean
1106
+ canRead:
1107
+ description: Does the member have read access for the scopeType and spaceContentType
1108
+ type: boolean
1109
+ canSchedule:
1110
+ description: Does the member have schedule access for the scopeType and spaceContentType
1111
+ type: boolean
1112
+ canTranslate:
1113
+ description: Does the member have translate access for the scopeType and spaceContentType
1114
+ type: boolean
1115
+ canUpdate:
1116
+ description: Does the member have update access for the scopeType and spaceContentType
1117
+ type: boolean
1118
+ ManagedContentSpaceRepresentation:
1119
+ description: Details of a Managed Content Space
1120
+ type: object
1121
+ properties:
1122
+ createdBy:
1123
+ description: User-Id of the creator of the Managed Content Space
1124
+ type: string
1125
+ createdDate:
1126
+ description: Date of creation of the Managed Content Space
1127
+ type: string
1128
+ defaultLanguage:
1129
+ description: Default Language of the Managed Content Space
1130
+ type: string
1131
+ description:
1132
+ description: Description of the Managed Content Space
1133
+ type: string
1134
+ id:
1135
+ description: Id of the Managed Content Space
1136
+ type: string
1137
+ lastModifiedBy:
1138
+ description: User-Id of the user who last modified the Managed Content Space
1139
+ type: string
1140
+ lastModifiedDate:
1141
+ description: Date on which the Managed Content Space was last modified
1142
+ type: string
1143
+ name:
1144
+ description: Name of the Managed Content Space
1145
+ type: string
1146
+ rootFolderId:
1147
+ description: Root Folder Id of the Managed Content Space
1148
+ type: string
1149
+ supportedLanguages:
1150
+ description: Set of supported languages in the Managed Content Space
1151
+ type: array
1152
+ items:
1153
+ type: string
1154
+ ManagedContentSpaceRoleCollectionRepresentation:
1155
+ description: Collection representation of the roles in a content space
1156
+ type: object
1157
+ properties:
1158
+ roles:
1159
+ description: List of the roles in the content space
1160
+ type: array
1161
+ items:
1162
+ type: ManagedContentSpaceRoleRepresentation
1163
+ ManagedContentSpaceRoleRepresentation:
1164
+ description: Representation of a ManagedContentSpaceRole
1165
+ type: object
1166
+ properties:
1167
+ description:
1168
+ description: The role description
1169
+ type: string
1170
+ id:
1171
+ description: The role ID
1172
+ type: string
1173
+ name:
1174
+ description: The role name
1175
+ type: string
1176
+ ManagedContentSpaceSummaryRepresentation:
1177
+ description: Information about a managed content space.
1178
+ type: object
1179
+ properties:
1180
+ id:
1181
+ description: Id of the managed content space.
1182
+ type: string
1183
+ resourceUrl:
1184
+ description: Connect API resource url to ge more information about managed
1185
+ content space.
1186
+ type: string
1187
+ ManagedContentTextNodeValueRepresentation:
1188
+ description: Information about a managed content node of type text.
1189
+ type: ManagedContentNodeValueRepresentation
1190
+ properties:
1191
+ value:
1192
+ description: The text value of the managed content node.
1193
+ type: string
1194
+ ManagedContentTranslationRepresentation:
1195
+ description: Information about a managed content translation job
1196
+ type: object
1197
+ properties:
1198
+ createdBy:
1199
+ description: The user id who created the managed content translation job
1200
+ type: string
1201
+ createdDate:
1202
+ description: The created date of the managed content translation job
1203
+ type: string
1204
+ errorBodyUrl:
1205
+ description: The URL to get the error content body of a managed content translation
1206
+ job
1207
+ type: string
1208
+ id:
1209
+ description: The id of a managed content translation job
1210
+ type: string
1211
+ inputBodyUrl:
1212
+ description: The URL to get the input content body of a managed content translation
1213
+ job
1214
+ type: string
1215
+ jobType:
1216
+ description: The type of a managed content translation job
1217
+ type: string
1218
+ enum:
1219
+ - Export
1220
+ - Import
1221
+ lastModifiedBy:
1222
+ description: The last user id who has modified the managed content translation
1223
+ job
1224
+ type: string
1225
+ lastModifiedDate:
1226
+ description: The last time the managed content translation job has been modified
1227
+ type: string
1228
+ lastStatusUpdateDate:
1229
+ description: The last status update date of a managed content translation
1230
+ job
1231
+ type: string
1232
+ name:
1233
+ description: The name of a managed content translation job
1234
+ type: string
1235
+ outputBodyUrl:
1236
+ description: The URL to get the output content body of a managed content translation
1237
+ job
1238
+ type: string
1239
+ startDate:
1240
+ description: The start date of a managed content translation job
1241
+ type: string
1242
+ status:
1243
+ description: The status of a managed content translation job
1244
+ type: string
1245
+ enum:
1246
+ - Completed
1247
+ - Created
1248
+ - Failed
1249
+ - Pending
1250
+ - Processing
1251
+ ManagedContentTranslationRequestInputRep:
1252
+ description: Input representation of a translation request
1253
+ type: object
1254
+ properties:
1255
+ contentBodyId:
1256
+ description: Indicates the content body id of the translation
1257
+ type: string
1258
+ managedContentSpaceId:
1259
+ description: Managed Content Space Id
1260
+ type: string
1261
+ name:
1262
+ description: Indicates the name of the translation
1263
+ type: string
1264
+ type:
1265
+ description: Indicates the type of the translation
1266
+ type: string
1267
+ enum:
1268
+ - Export
1269
+ - Import
1270
+ ManagedContentTypeRepresentation:
1271
+ description: Information about a managed content type.
1272
+ type: object
1273
+ properties:
1274
+ label:
1275
+ description: The label of the managed content type..
1276
+ type: string
1277
+ name:
1278
+ description: The developer name of the managed content type.
1279
+ type: string
1280
+ nodeTypes:
1281
+ description: The collection of node types in this managed content type..
1282
+ type: object
1283
+ properties:
1284
+ //:
1285
+ type: ManagedContentNodeTypeRepresentation
1286
+ ManagedContentTypeSchemaRepresentation:
1287
+ description: Representation of the ManagedContentType based on schema and associated
1288
+ views.
1289
+ type: object
1290
+ properties:
1291
+ description:
1292
+ description: Text description for the ManagedContentType
1293
+ type: string
1294
+ required: false # TODO W-8891123 Hand rolled
1295
+ developerName:
1296
+ description: Developer Name of the ManagedContentType
1297
+ type: string
1298
+ required: false # TODO W-8891123 Hand rolled
1299
+ label:
1300
+ description: Display name of the ManagedContentType
1301
+ type: string
1302
+ required: false # TODO W-8891123 Hand rolled
1303
+ namespacePrefix:
1304
+ description: Namespace prefix for the ManagedContentType
1305
+ type: string
1306
+ required: false # TODO W-8891123 Hand rolled
1307
+ schema:
1308
+ description: JSON Schema representation of the ManagedContentType
1309
+ type: object
1310
+ properties:
1311
+ //:
1312
+ type: any # TODO hand rolled. TD-0100382
1313
+ required: false # TODO W-8891123 Hand rolled
1314
+ views:
1315
+ description: Views Representing the ManagedContentType
1316
+ type: array
1317
+ required: false # TODO W-8891123 Hand rolled
1318
+ items:
1319
+ type: ManagedContentTypeViewRepresentation
1320
+ ManagedContentTypeSearchableCollectionRepresentation:
1321
+ description: Collection of Content Type Search Status
1322
+ type: object
1323
+ properties:
1324
+ currentPageUrl:
1325
+ description: URL to the current page of Manage Content Type Search Status
1326
+ records. The default is 25 managed content channels per page.
1327
+ type: string
1328
+ items:
1329
+ description: Manage Content Type Searchable records corresponding to the current
1330
+ page
1331
+ type: array
1332
+ items:
1333
+ type: ManagedContentTypeSearchableRepresentation
1334
+ nextPageUrl:
1335
+ description: URL to the next page of Manage Content Type Search Status records.
1336
+ The default is 25 managed content channels per page.
1337
+ type: string
1338
+ totalItems:
1339
+ description: Total count of Manage Content Type Search Status records across
1340
+ all pages
1341
+ type: integer
1342
+ ManagedContentTypeSearchableInputRepresentation:
1343
+ description: The input representation for a content type search status
1344
+ type: object
1345
+ properties:
1346
+ isSearchable:
1347
+ description: Searchable status of the Content Type
1348
+ type: boolean
1349
+ name:
1350
+ description: Name of the Content Type
1351
+ type: string
1352
+ ManagedContentTypeSearchableRepresentation:
1353
+ description: Details of a Managed Content Type Search Status
1354
+ type: object
1355
+ properties:
1356
+ id:
1357
+ description: Id of the Managed Content Type
1358
+ type: string
1359
+ isSearchable:
1360
+ description: Is the contentType searchable
1361
+ type: boolean
1362
+ label:
1363
+ description: Master label of the Managed Content Type
1364
+ type: string
1365
+ name:
1366
+ description: Developer Name of the Managed Content Type
1367
+ type: string
1368
+ ManagedContentTypeSummaryRepresentation:
1369
+ description: Information about a managed content type.
1370
+ type: object
1371
+ properties:
1372
+ developerName:
1373
+ description: Unique developer name of a managed content type.
1374
+ type: string
1375
+ namespacePrefix:
1376
+ description: Unique namespace prefix of a managed content type.
1377
+ type: string
1378
+ ManagedContentTypeViewRepresentation:
1379
+ description: Representation of managed content type view list
1380
+ type: object
1381
+ properties:
1382
+ view:
1383
+ description: View associated with the schema
1384
+ type: object
1385
+ properties:
1386
+ //:
1387
+ type: any # TODO hand rolled. TD-0100382
1388
+ viewMode:
1389
+ description: View Mode of current view.
1390
+ type: string
1391
+ enum:
1392
+ - Edit
1393
+ - View
1394
+ viewType:
1395
+ description: View type of current view.
1396
+ type: string
1397
+ enum:
1398
+ - LightningView
1399
+ ManagedContentUserSummaryRepresentation:
1400
+ description: Information about a user who created/modified content.
1401
+ type: object
1402
+ properties:
1403
+ id:
1404
+ description: The id of the user.
1405
+ type: string
1406
+ resourceUrl:
1407
+ description: The connect endpoint resourceUrl of the user to get more information
1408
+ about the user.
1409
+ type: string
1410
+ ManagedContentVariantRepresentation:
1411
+ description: Information about a managed content variant in authoring space.
1412
+ type: object
1413
+ properties:
1414
+ contentBody:
1415
+ description: Body contains raw fields defined in the managed content type
1416
+ schema of this managed content variant.
1417
+ type: object
1418
+ properties:
1419
+ //:
1420
+ type: object
1421
+ contentKey:
1422
+ description: Globally unique identifier of a managed content and doesn't change
1423
+ when managed content is moved between production and sandbox environments.
1424
+ type: string
1425
+ contentSpace:
1426
+ description: The content space of the managed content.
1427
+ type: ManagedContentSpaceSummaryRepresentation
1428
+ contentType:
1429
+ description: The type of the managed content.
1430
+ type: ManagedContentTypeSummaryRepresentation
1431
+ createdBy:
1432
+ description: The user who created the managed content variant.
1433
+ type: ManagedContentUserSummaryRepresentation
1434
+ createdDate:
1435
+ description: The created date of the managed content variant.
1436
+ type: string
1437
+ folder:
1438
+ description: The content folder of the managed content.
1439
+ type: ManagedContentFolderSummaryRepresentation
1440
+ language:
1441
+ description: The language of the managed content.
1442
+ type: string
1443
+ lastModifiedBy:
1444
+ description: The last user who has modified the managed content variant.
1445
+ type: ManagedContentUserSummaryRepresentation
1446
+ lastModifiedDate:
1447
+ description: The last time the managed content variant has been modified.
1448
+ type: string
1449
+ managedContentId:
1450
+ description: Id of the managed content in authoring space.
1451
+ type: string
1452
+ managedContentVariantId:
1453
+ description: The managed content variant in the authoring space.
1454
+ type: string
1455
+ managedContentVersionId:
1456
+ description: Version id of the managed content version.
1457
+ type: string
1458
+ title:
1459
+ description: The title of the managed content.
1460
+ type: string
1461
+ urlName:
1462
+ description: The content url name of the managed content.
1463
+ type: string
1464
+ ManagedContentVariantUpdateInputRepresentation:
1465
+ description: Input representation of a managed content variant for PUT request
1466
+ type: object
1467
+ properties:
1468
+ contentBody:
1469
+ description: The body of the managed content variant
1470
+ type: object
1471
+ properties:
1472
+ //:
1473
+ type: object
1474
+ title:
1475
+ description: The title of the managed content variant
1476
+ type: string
1477
+ urlName:
1478
+ description: URL-friendly identifier of the content within the org.
1479
+ type: string
1480
+ ManagedContentVariantV1InputRep:
1481
+ description: Input representation of a managed content variant request
1482
+ type: object
1483
+ properties:
1484
+ body:
1485
+ description: Indicates the body of a variation
1486
+ type: object
1487
+ language:
1488
+ description: Indicates the language of a variation
1489
+ type: string
1490
+ managedContentVersionId:
1491
+ description: Managed Content Version Id
1492
+ type: string
1493
+ name:
1494
+ description: Indicates the name of a variation
1495
+ type: string
1496
+ parentId:
1497
+ description: Indicates the parent id of a variation
1498
+ type: string
1499
+ type:
1500
+ description: Indicates the type of the ManagedContentVariant
1501
+ type: string
1502
+ enum:
1503
+ - Translation
1504
+ - Variation
1505
+ urlName:
1506
+ description: Indicates the url name of a variation
1507
+ type: string
1508
+ ManagedContentVariantV1Representation:
1509
+ description: Information about a managed content variant
1510
+ type: object
1511
+ properties:
1512
+ body:
1513
+ description: The body of a managed content variant
1514
+ type: string
1515
+ id:
1516
+ description: The id of a managed content variant
1517
+ type: string
1518
+ language:
1519
+ description: The language of a managed content variant
1520
+ type: string
1521
+ managedContentVersionId:
1522
+ description: The id of a managed content version
1523
+ type: string
1524
+ name:
1525
+ description: The name of a managed content variant
1526
+ type: string
1527
+ parentId:
1528
+ description: The id of a parent
1529
+ type: string
1530
+ urlName:
1531
+ description: The url name of a managed content variant
1532
+ type: string
1533
+ variantType:
1534
+ description: The variant of a managed content variant
1535
+ type: string
1536
+ enum:
1537
+ - Translation
1538
+ - Variation
1539
+ ManagedContentVersionCollectionRepresentation:
1540
+ description: Collection of managed content versions.
1541
+ type: object
1542
+ properties:
1543
+ currentPageUrl:
1544
+ description: URL to the current page of managed content versions. The default
1545
+ is 25 managed content versions per page.
1546
+ type: string
1547
+ items:
1548
+ description: Managed content versions for this page.
1549
+ type: array
1550
+ items:
1551
+ type: ManagedContentVersionRepresentation
1552
+ managedContentTypes:
1553
+ description: Managed content types for this page.
1554
+ type: object
1555
+ properties:
1556
+ //:
1557
+ type: ManagedContentTypeRepresentation
1558
+ nextPageUrl:
1559
+ description: URL to the next page of managed content versions, The default
1560
+ is 25 managed content versions per page.
1561
+ type: string
1562
+ total:
1563
+ description: Total number of versions across all pages.
1564
+ type: integer
1565
+ totalTypes:
1566
+ description: Total number of content types across all pages.
1567
+ type: integer
1568
+ ManagedContentVersionInputRep:
1569
+ description: Input representation for a managed content
1570
+ type: object
1571
+ properties:
1572
+ associations:
1573
+ description: 'Input Representation for associations for managed content. Describes
1574
+ how a ManagedContent is organized. Examples are the list of topics that
1575
+ are assigned to a ManagedContent and the folders in which the ManagedContent
1576
+ is placed. '
1577
+ type: object
1578
+ body:
1579
+ description: The body of the managed content version.
1580
+ type: object
1581
+ properties:
1582
+ //:
1583
+ type: object
1584
+ managedContentId:
1585
+ description: 'Id of a managed content id. This is only required when creating
1586
+ a new version of an already existing managed content. If this is specified
1587
+ the operation will mean “create a new version of the managed content with
1588
+ id”. '
1589
+ type: string
1590
+ spaceFolderId:
1591
+ description: Id of a ManagedContentSpaceFolder in which the Content should
1592
+ be created.
1593
+ type: string
1594
+ title:
1595
+ description: The title of the managed content version.
1596
+ type: string
1597
+ type:
1598
+ description: The type of the managed content, represents a category of content
1599
+ such as News, Blog or Story. The ManagedContentType.DeveloperName of the
1600
+ active ManagedContentTypeVersion of the ManagedContentVersion. This is always
1601
+ required.
1602
+ type: string
1603
+ urlName:
1604
+ description: A string that uniquely identifies the content within the org,
1605
+ could be used in e.g. URLs.
1606
+ type: string
1607
+ ManagedContentVersionInternalCollectionRepresentation:
1608
+ description: Collection of managed content versions.
1609
+ type: object
1610
+ properties:
1611
+ items:
1612
+ description: Managed content versions for this page.
1613
+ type: array
1614
+ items:
1615
+ type: ManagedContentVersionInternalRepresentation
1616
+ total:
1617
+ description: Total number of versions accros all pages.
1618
+ type: integer
1619
+ ManagedContentVersionInternalRepresentation:
1620
+ description: Information about a managed content version.
1621
+ type: object
1622
+ properties:
1623
+ associations:
1624
+ description: The Managed Content Associations, e.g. topic associations, describing
1625
+ how this Managed Content is organized and discoverable
1626
+ type: ManagedContentAssociationsRepresentation
1627
+ authoredManagedContentId:
1628
+ description: The unique identifer of the managed content in the authoring
1629
+ space.
1630
+ type: string
1631
+ body:
1632
+ description: Get the body
1633
+ type: object
1634
+ properties:
1635
+ //:
1636
+ type: object
1637
+ contentKey:
1638
+ description: The content key
1639
+ type: string
1640
+ createdByReference:
1641
+ description: Reference to the user who created the managed content version.
1642
+ type: ReferenceRepresentation
1643
+ createdDate:
1644
+ description: Get the date when the managed content version was created.
1645
+ type: string
1646
+ id:
1647
+ description: Response record Id
1648
+ type: string
1649
+ lastUpdatedByReference:
1650
+ description: Reference to the user who updated the managed content version.
1651
+ type: ReferenceRepresentation
1652
+ managedContentId:
1653
+ description: Id of the managed content that this is a version of
1654
+ type: string
1655
+ masterLanguage:
1656
+ description: Master Language of the managed content in the authoring space.
1657
+ type: string
1658
+ publishDate:
1659
+ description: Get the date when managed content version was published.
1660
+ type: string
1661
+ status:
1662
+ description: The status of the managed content version.
1663
+ type: string
1664
+ title:
1665
+ description: Get the title of the managed content version.
1666
+ type: string
1667
+ type:
1668
+ description: The type of the managed content version.
1669
+ type: string
1670
+ typeLabel:
1671
+ description: The type label of the managed content version.
1672
+ type: string
1673
+ updatedDate:
1674
+ description: Get the date when the managed content version was updated.
1675
+ type: string
1676
+ urlName:
1677
+ description: The url of the managed content version
1678
+ type: string
1679
+ ReferenceRepresentation:
1680
+ description: A reference to another record in the organization without including all of the information about that record.
1681
+ type: object
1682
+ properties:
1683
+ id:
1684
+ description: The ID of the object being referenced, which could be an 18-character ID or some other string identifier.
1685
+ type: string
1686
+ url:
1687
+ description: URL to the resource endpoint.
1688
+ type: string #TODO W-8271735 to track difference from expected object in url
1689
+ ManagedContentVersionRepresentation:
1690
+ description: Information about a managed content version.
1691
+ type: object
1692
+ properties:
1693
+ associations:
1694
+ description: The Managed Content Associations, e.g. topic associations, describing
1695
+ how this Managed Content is organized and discoverable
1696
+ type: ManagedContentAssociationsRepresentation
1697
+ contentKey:
1698
+ description: The content key
1699
+ type: string
1700
+ contentNodes:
1701
+ description: Get the content nodes
1702
+ type: object
1703
+ properties:
1704
+ //:
1705
+ type: ManagedContentNodeValueRepresentation
1706
+ contentUrlName:
1707
+ description: The content url name of the managed content version.
1708
+ type: string
1709
+ language:
1710
+ description: The language of the managed content version.
1711
+ type: string
1712
+ managedContentId:
1713
+ description: The unique identifier of the managed content in the authoring
1714
+ space.
1715
+ type: string
1716
+ publishedDate:
1717
+ description: Get the date when the managed content version was last published.
1718
+ type: string
1719
+ title:
1720
+ description: Get the title of the managed content version.
1721
+ type: string
1722
+ type:
1723
+ description: The type of the managed content version.
1724
+ type: string
1725
+ typeLabel:
1726
+ description: The type label of the managed content type.
1727
+ type: string
1728
+ unauthenticatedUrl:
1729
+ description: Unauthenticated delivery Url
1730
+ type: string
1731
+ ManagedContentVersionSiteNodeCollectionRepresentation:
1732
+ description: The managed content version node collection representation of a content
1733
+ for a site
1734
+ type: object
1735
+ properties:
1736
+ nodes:
1737
+ description: parentId of the node returned
1738
+ type: array
1739
+ items:
1740
+ type: ManagedContentVersionSiteNodeRepresentation
1741
+ ManagedContentVersionSiteNodeRepresentation:
1742
+ description: The managed content version node representation of a content for
1743
+ a site
1744
+ type: object
1745
+ properties:
1746
+ contentKey:
1747
+ description: Content key of a Managed Content
1748
+ type: string
1749
+ id:
1750
+ description: id of the node returned
1751
+ type: string
1752
+ managedContentVersionId:
1753
+ description: Managed Content Version id
1754
+ type: string
1755
+ nodeBody:
1756
+ description: Node body
1757
+ type: string
1758
+ parentId:
1759
+ description: parentId of the node returned
1760
+ type: string
1761
+ ManagedContentVersionV2CollectionInputRepresentation:
1762
+ description: Input representation for collection of managed content version
1763
+ type: object
1764
+ properties:
1765
+ managedContentVersions:
1766
+ description: List of IDs of the ManagedContentVersion that need to be bulk
1767
+ inserted.
1768
+ type: array
1769
+ items:
1770
+ type: object
1771
+ ManagedContentVersionV2CollectionRepresentation:
1772
+ description: Collection of json based managed content versions.
1773
+ type: object
1774
+ properties:
1775
+ total:
1776
+ description: Total number of versions across all pages.
1777
+ type: integer
1778
+ versions:
1779
+ description: Managed content versions for this page.
1780
+ type: array
1781
+ items:
1782
+ type: ManagedContentVersionV2Representation
1783
+ ManagedContentVersionV2InputRepresentation:
1784
+ description: Input representation for a managed content version
1785
+ type: object
1786
+ properties:
1787
+ body:
1788
+ description: The body of the managed content version.
1789
+ type: object
1790
+ properties:
1791
+ //:
1792
+ type: object
1793
+ contentKey:
1794
+ description: Content Key of a managed content id.
1795
+ type: string
1796
+ language:
1797
+ description: The language of the managed content version.
1798
+ type: string
1799
+ managedContentId:
1800
+ description: 'Id of a managed content id. This is only required when creating
1801
+ a new version of an already existing managed content. If this is specified
1802
+ the operation will mean “create a new version of the managed content with
1803
+ id”. '
1804
+ type: string
1805
+ parentIdOrKey:
1806
+ description: Content Key of Parent Managed Content
1807
+ type: string
1808
+ title:
1809
+ description: The title of the managed content version.
1810
+ type: string
1811
+ type:
1812
+ description: The type of the managed content, represents a category of content
1813
+ such as News, Blog or Story. The ManagedContentType.DeveloperName of the
1814
+ active ManagedContentTypeVersion of the ManagedContentVersion. This is always
1815
+ required.
1816
+ type: string
1817
+ urlName:
1818
+ description: A string that uniquely identifies the content within the org,
1819
+ could be used in e.g. URLs.
1820
+ type: string
1821
+ ManagedContentVersionV2Representation:
1822
+ description: Information about a managed content version.
1823
+ type: object
1824
+ properties:
1825
+ body:
1826
+ description: Get body of the managed content version.
1827
+ type: object
1828
+ properties:
1829
+ //:
1830
+ type: object
1831
+ contentKey:
1832
+ description: Content Key of the managed content.
1833
+ type: string
1834
+ createdBy:
1835
+ description: The user id who created the managed content version
1836
+ type: string
1837
+ createdDate:
1838
+ description: The created date of the managed content version
1839
+ type: string
1840
+ id:
1841
+ description: The unique identifier of the managed content version in the authoring
1842
+ space.
1843
+ type: string
1844
+ language:
1845
+ description: The master language of the managed content version.
1846
+ type: string
1847
+ lastModifiedBy:
1848
+ description: The last user id who has modified the managed content version
1849
+ type: string
1850
+ lastModifiedDate:
1851
+ description: The last time the managed content version has been modified
1852
+ type: string
1853
+ managedContentId:
1854
+ description: The unique identifier of the managed content in the authoring
1855
+ space.
1856
+ type: string
1857
+ parentId:
1858
+ description: Parent ManagedContent Id of the managed content version.
1859
+ type: string
1860
+ renditionLanguage:
1861
+ description: The language of the managed content version.
1862
+ type: string
1863
+ status:
1864
+ description: Get status of the managed content version.
1865
+ type: string
1866
+ title:
1867
+ description: Get the title of the managed content version.
1868
+ type: string
1869
+ type:
1870
+ description: The type of the managed content version.
1871
+ type: string
1872
+ urlName:
1873
+ description: The content url name of the managed content version.
1874
+ type: string
1875
+ TopicSummaryRepresentation:
1876
+ description: A summary of a topic
1877
+ type: object
1878
+ properties:
1879
+ id:
1880
+ description: The ID of the topic
1881
+ type: string
1882
+ name:
1883
+ description: The name of the topic
1884
+ type: string
1885
+ StreamedRepresentation: # TODO Hand rolled
1886
+ description: streamed representation.
1887
+ type: object
1888
+ properties: {}
1889
+ /cms: # TODO hand rolled. (removed /:)
1890
+ /contents:
1891
+ # TODO: Hand rolled
1892
+ # post:
1893
+ # description: Create Managed Content for Json store
1894
+ # responses:
1895
+ # '200':
1896
+ # description: Success
1897
+ # body:
1898
+ # application/json:
1899
+ # type: ManagedContentDocumentRepresentation
1900
+ # body:
1901
+ # application/json:
1902
+ # type: ManagedContentInputRepresentation
1903
+ # (oas-body-name): ManagedContentInputParam
1904
+ /contents/{contentKeyOrId}:
1905
+ get:
1906
+ description: Gets existing managed content for provided version.
1907
+ responses:
1908
+ '200':
1909
+ description: Success
1910
+ body:
1911
+ application/json:
1912
+ type: ManagedContentDocumentRepresentation
1913
+ queryParameters:
1914
+ version:
1915
+ description: An 18-character unique Salesforce identifier for the content
1916
+ version.
1917
+ type: string
1918
+ required: false
1919
+ uriParameters:
1920
+ contentKeyOrId:
1921
+ description: A unique identifier or ID of a content.
1922
+ type: string
1923
+ required: true
1924
+ /delivery:
1925
+ /channels/{channelId}/variants:
1926
+ # TODO: Hand rolled
1927
+ # post:
1928
+ # description: Get a list of variants published to a channel filtered by a
1929
+ # variant key and list of contentIds
1930
+ # responses:
1931
+ # '200':
1932
+ # description: Success
1933
+ # body:
1934
+ # application/json:
1935
+ # type: MCDeliveryV2VariantCollectionRepresentation
1936
+ # body:
1937
+ # application/json:
1938
+ # type: MCDeliveryV2VariantInputRepresentation
1939
+ # (oas-body-name): MCVariantDeliveryByContentIdAndVariantKey
1940
+ uriParameters:
1941
+ channelId:
1942
+ type: string
1943
+ required: true
1944
+ /{targetId}/collection/{collectionNameOrContentKey}:
1945
+ get:
1946
+ description: Get list of collection items.
1947
+ responses:
1948
+ '200':
1949
+ description: Success
1950
+ body:
1951
+ application/json:
1952
+ type: MContentCollectionRepresentation
1953
+ queryParameters:
1954
+ language:
1955
+ type: string
1956
+ required: false
1957
+ page:
1958
+ type: integer
1959
+ required: false
1960
+ pageSize:
1961
+ type: integer
1962
+ required: false
1963
+ uriParameters:
1964
+ collectionNameOrContentKey:
1965
+ type: string
1966
+ required: true
1967
+ targetId:
1968
+ type: string
1969
+ required: true
1970
+ /{targetId}/collection/{collectionNameOrContentKey}/metadata:
1971
+ get:
1972
+ description: Get collection metadata.
1973
+ responses:
1974
+ '200':
1975
+ description: Success
1976
+ body:
1977
+ application/json:
1978
+ type: MContentCollectionMetadataRepresentation
1979
+ queryParameters:
1980
+ language:
1981
+ type: string
1982
+ required: false
1983
+ uriParameters:
1984
+ collectionNameOrContentKey:
1985
+ type: string
1986
+ required: true
1987
+ targetId:
1988
+ type: string
1989
+ required: true
1990
+ /deployments:
1991
+ get:
1992
+ description: Get deployments Information for the given space or ManagedContentVersion
1993
+ or deploymentId
1994
+ responses:
1995
+ '200':
1996
+ description: Success
1997
+ body:
1998
+ application/json:
1999
+ type: ManagedContentDeploymentCollectionRepresentation
2000
+ queryParameters:
2001
+ contentSpaceId:
2002
+ type: string
2003
+ required: false
2004
+ deploymentId:
2005
+ type: string
2006
+ required: false
2007
+ deploymentStatus:
2008
+ type: string
2009
+ required: false
2010
+ enum:
2011
+ - Canceled
2012
+ - Created
2013
+ - Deployed
2014
+ - Error
2015
+ - Staged
2016
+ deploymentType:
2017
+ type: string
2018
+ required: false
2019
+ enum:
2020
+ - Publish
2021
+ - Unpublish
2022
+ managedContentVersionId:
2023
+ type: string
2024
+ required: false
2025
+ page:
2026
+ type: integer
2027
+ required: false
2028
+ pageSize:
2029
+ type: integer
2030
+ required: false
2031
+ # TODO: Hand rolled
2032
+ # post:
2033
+ # description: Create a deployment to a specific channel
2034
+ # responses:
2035
+ # '200':
2036
+ # description: Success
2037
+ # body:
2038
+ # application/json:
2039
+ # type: ManagedContentDeploymentRepresentation
2040
+ # body:
2041
+ # application/json:
2042
+ # type: ManagedContentDeploymentInputRepresentation
2043
+ # (oas-body-name): DeploymentInput
2044
+ /deployments/{deploymentId}:
2045
+ delete:
2046
+ description: Delete and cleanup all resources used by a deployment
2047
+ responses:
2048
+ '200':
2049
+ description: Success
2050
+ # TODO: Hand rolled
2051
+ # patch:
2052
+ # description: Patch a deployment
2053
+ # responses:
2054
+ # '200':
2055
+ # description: Success
2056
+ # body:
2057
+ # application/json:
2058
+ # type: ManagedContentDeploymentRepresentation
2059
+ uriParameters:
2060
+ deploymentId:
2061
+ type: string
2062
+ required: true
2063
+ /site-author/content:
2064
+ /content-keys:
2065
+ get:
2066
+ description: Get the managed content versions, can include children and
2067
+ maked for delete versions
2068
+ responses:
2069
+ '200':
2070
+ description: Success
2071
+ body:
2072
+ application/json:
2073
+ type: MCSiteContentCollectionRepresentation
2074
+ queryParameters:
2075
+ contentKeys:
2076
+ type: array
2077
+ required: false
2078
+ items:
2079
+ type: string
2080
+ (oas-collectionFormat): csv
2081
+ includeChildren:
2082
+ type: string
2083
+ required: false
2084
+ includeMarkForDeleted:
2085
+ type: string
2086
+ required: false
2087
+ /{contentKey}:
2088
+ delete:
2089
+ description: Delete a Managed Content.
2090
+ responses:
2091
+ '200':
2092
+ description: Success
2093
+ queryParameters:
2094
+ deleteType:
2095
+ type: string
2096
+ required: false
2097
+ get:
2098
+ description: Get a managed content version, can include children
2099
+ responses:
2100
+ '200':
2101
+ description: Success
2102
+ body:
2103
+ application/json:
2104
+ type: MCSiteContentRepresentation
2105
+ queryParameters:
2106
+ includeChildren:
2107
+ type: string
2108
+ required: false
2109
+ uriParameters:
2110
+ contentKey:
2111
+ type: string
2112
+ required: true
2113
+ /node/{contentNode}:
2114
+ get:
2115
+ description: Get a managed content node for the top level content key
2116
+ responses:
2117
+ '200':
2118
+ description: Success
2119
+ body:
2120
+ application/json:
2121
+ type: ManagedContentVersionSiteNodeRepresentation
2122
+ uriParameters:
2123
+ contentKey:
2124
+ type: string
2125
+ required: true
2126
+ contentNode:
2127
+ type: string
2128
+ required: true
2129
+ /nodes:
2130
+ get:
2131
+ description: Get managed content nodes for the top level content key and
2132
+ given nodeIds
2133
+ responses:
2134
+ '200':
2135
+ description: Success
2136
+ body:
2137
+ application/json:
2138
+ type: ManagedContentVersionSiteNodeCollectionRepresentation
2139
+ queryParameters:
2140
+ contentNodes:
2141
+ type: array
2142
+ required: false
2143
+ items:
2144
+ type: string
2145
+ (oas-collectionFormat): csv
2146
+ uriParameters:
2147
+ contentKey:
2148
+ type: string
2149
+ required: true
2150
+ /site-delivery/{channelId}/contents:
2151
+ /content-keys:
2152
+ # TODO: Hand rolled
2153
+ # post:
2154
+ # description: Get the contents published to a site by their content keys
2155
+ # responses:
2156
+ # '200':
2157
+ # description: Success
2158
+ # body:
2159
+ # application/json:
2160
+ # type: MCSiteContentCollectionRepresentation
2161
+ # body:
2162
+ # application/json:
2163
+ # type: MCSiteDeliveryByContentKeysInputRepresentation
2164
+ # (oas-body-name): SiteDeliveryByContentKeys
2165
+ uriParameters:
2166
+ channelId:
2167
+ type: string
2168
+ required: true
2169
+ /content-types:
2170
+ # TODO: Hand rolled
2171
+ # post:
2172
+ # description: Get the contents published to a site by their content types
2173
+ # responses:
2174
+ # '200':
2175
+ # description: Success
2176
+ # body:
2177
+ # application/json:
2178
+ # type: ManagedContentCollectionRepresentation
2179
+ # body:
2180
+ # application/json:
2181
+ # type: MCSiteDeliveryByContentTypesInputRepresentation
2182
+ # (oas-body-name): SiteDeliveryByContentTypes
2183
+ uriParameters:
2184
+ channelId:
2185
+ type: string
2186
+ required: true
2187
+ /node-ids:
2188
+ # TODO: Hand rolled
2189
+ # post:
2190
+ # description: Get the nodes in a content published to a site by their node
2191
+ # ids
2192
+ # responses:
2193
+ # '200':
2194
+ # description: Success
2195
+ # body:
2196
+ # application/json:
2197
+ # type: MCSiteNodeCollectionRepresentation
2198
+ # body:
2199
+ # application/json:
2200
+ # type: MCSiteDeliveryByNodesInputRepresentation
2201
+ # (oas-body-name): SiteDeliveryByNodeIds
2202
+ uriParameters:
2203
+ channelId:
2204
+ type: string
2205
+ required: true
2206
+ /spaces/{contentSpaceId}:
2207
+ get:
2208
+ description: Get a specific ManagedContentSpace record
2209
+ responses:
2210
+ '200':
2211
+ description: Success
2212
+ body:
2213
+ application/json:
2214
+ type: ManagedContentSpaceRepresentation
2215
+ uriParameters:
2216
+ contentSpaceId:
2217
+ type: string
2218
+ required: true
2219
+ /connect:
2220
+ /cms:
2221
+ /channels/{channelId}/searchable-content-types:
2222
+ get:
2223
+ description: Get searchable status of managed content types in a channel.
2224
+ responses:
2225
+ '200':
2226
+ description: Success
2227
+ body:
2228
+ application/json:
2229
+ type: ManagedContentTypeSearchableCollectionRepresentation
2230
+ queryParameters:
2231
+ page:
2232
+ type: integer
2233
+ required: false
2234
+ pageSize:
2235
+ type: integer
2236
+ required: false
2237
+ patch:
2238
+ description: Update searchable status of a managed content type
2239
+ responses:
2240
+ '200':
2241
+ description: Success
2242
+ body:
2243
+ application/json:
2244
+ type: ManagedContentTypeSearchableRepresentation
2245
+ body:
2246
+ application/json:
2247
+ type: ManagedContentTypeSearchableInputRepresentation
2248
+ (oas-body-name): contentTypeSearchInput
2249
+ uriParameters:
2250
+ channelId:
2251
+ type: string
2252
+ required: true
2253
+ /content:
2254
+ get:
2255
+ description: Get ist of managed content id and its corresponding managed
2256
+ content space ids
2257
+ responses:
2258
+ '200':
2259
+ description: Success
2260
+ body:
2261
+ application/json:
2262
+ type: ManagedContentDetailCollectionRepresentation
2263
+ queryParameters:
2264
+ contentKeys:
2265
+ type: array
2266
+ required: false
2267
+ items:
2268
+ type: string
2269
+ (oas-collectionFormat): csv
2270
+ managedContentIds:
2271
+ type: array
2272
+ required: false
2273
+ items:
2274
+ type: string
2275
+ (oas-collectionFormat): csv
2276
+ /jobs:
2277
+ /export:
2278
+ # TODO: Hand rolled
2279
+ # post:
2280
+ # description: Create a job for exporting Managed Content
2281
+ # responses:
2282
+ # '200':
2283
+ # description: Success
2284
+ # body:
2285
+ # application/json:
2286
+ # type: ManagedContentJobRepresentation
2287
+ # body:
2288
+ # application/json:
2289
+ # type: ManagedContentExportContentJobRequestInputRepresentation
2290
+ # (oas-body-name): managedContentJobRequest
2291
+ /import:
2292
+ # TODO: Hand rolled
2293
+ # post:
2294
+ # description: Create a job for importing Managed Content
2295
+ # responses:
2296
+ # '200':
2297
+ # description: Success
2298
+ # body:
2299
+ # application/json:
2300
+ # type: ManagedContentJobRepresentation
2301
+ # body:
2302
+ # application/json:
2303
+ # type: ManagedContentJobRequestInputRepresentation
2304
+ # (oas-body-name): managedContentJobRequest
2305
+ /{jobId}:
2306
+ delete:
2307
+ description: Delete an instance of a ManagedContentImportExportJob.
2308
+ responses:
2309
+ '200':
2310
+ description: Success
2311
+ get:
2312
+ description: Get a specific Managed Content Job (CMS Import/Export)
2313
+ record
2314
+ responses:
2315
+ '200':
2316
+ description: Success
2317
+ body:
2318
+ application/json:
2319
+ type: ManagedContentJobRepresentation
2320
+ uriParameters:
2321
+ jobId:
2322
+ type: string
2323
+ required: true
2324
+ /spaces/{contentSpaceId}:
2325
+ /version:
2326
+ # TODO: Hand rolled
2327
+ # post:
2328
+ # description: Create Managed Content Version for Json store
2329
+ # responses:
2330
+ # '200':
2331
+ # description: Success
2332
+ # body:
2333
+ # application/json:
2334
+ # type: ManagedContentVersionV2Representation
2335
+ # body:
2336
+ # application/json:
2337
+ # type: ManagedContentVersionV2InputRepresentation
2338
+ # (oas-body-name): managedContentVersionV2Request
2339
+ uriParameters:
2340
+ contentSpaceId:
2341
+ type: string
2342
+ required: true
2343
+ /versions:
2344
+ # TODO: Hand rolled
2345
+ # post:
2346
+ # description: Create Managed Content Versions for Json store
2347
+ # responses:
2348
+ # '200':
2349
+ # description: Success
2350
+ # body:
2351
+ # application/json:
2352
+ # type: ManagedContentVersionV2CollectionRepresentation
2353
+ # body:
2354
+ # application/json:
2355
+ # type: ManagedContentVersionV2CollectionInputRepresentation
2356
+ # (oas-body-name): managedContentVersionV2CollectionRequest
2357
+ uriParameters:
2358
+ contentSpaceId:
2359
+ type: string
2360
+ required: true
2361
+ /variant:
2362
+ # TODO: Hand rolled
2363
+ # post:
2364
+ # description: Create a managed content variant
2365
+ # responses:
2366
+ # '200':
2367
+ # description: Success
2368
+ # body:
2369
+ # application/json:
2370
+ # type: ManagedContentVariantV1Representation
2371
+ # body:
2372
+ # application/json:
2373
+ # type: ManagedContentVariantV1InputRep
2374
+ # (oas-body-name): variantRequest
2375
+ /version/{managedContentVersionId}:
2376
+ get:
2377
+ description: Get a single managed content version
2378
+ responses:
2379
+ '200':
2380
+ description: Success
2381
+ body:
2382
+ application/json:
2383
+ type: ManagedContentVersionV2Representation
2384
+ queryParameters:
2385
+ language:
2386
+ type: string
2387
+ required: false
2388
+ variantType:
2389
+ type: string
2390
+ required: false
2391
+ # TODO: Hand rolled
2392
+ # patch:
2393
+ # description: Patch a single managed content version
2394
+ # responses:
2395
+ # '200':
2396
+ # description: Success
2397
+ # body:
2398
+ # application/json:
2399
+ # type: ManagedContentVersionV2Representation
2400
+ # body:
2401
+ # application/json:
2402
+ # type: ManagedContentVersionV2InputRepresentation
2403
+ # (oas-body-name): managedContentVersionV2Request
2404
+ # put:
2405
+ # description: Put a single managed content version
2406
+ # responses:
2407
+ # '200':
2408
+ # description: Success
2409
+ # body:
2410
+ # application/json:
2411
+ # type: ManagedContentVersionV2Representation
2412
+ # body:
2413
+ # application/json:
2414
+ # type: ManagedContentVersionV2InputRepresentation
2415
+ # (oas-body-name): managedContentVersionV2Request
2416
+ uriParameters:
2417
+ managedContentVersionId:
2418
+ type: string
2419
+ required: true
2420
+ /content-types/{contentTypeFQN}:
2421
+ get:
2422
+ description: Gets the actual JSON Schema associated with the specified content
2423
+ type fully qualified name, after transformation using the provided filters.
2424
+ responses:
2425
+ '200':
2426
+ description: Success
2427
+ body:
2428
+ application/json:
2429
+ type: ManagedContentTypeSchemaRepresentation
2430
+ queryParameters:
2431
+ includeSchemaDefinitions:
2432
+ description: Generate Inline Schema Definitions
2433
+ type: boolean
2434
+ required: false
2435
+ language:
2436
+ description: Language of the schema
2437
+ type: string
2438
+ required: false
2439
+ viewMode:
2440
+ description: View/Edit Mode
2441
+ type: array
2442
+ required: false
2443
+ items:
2444
+ type: string
2445
+ enum:
2446
+ - Edit
2447
+ - View
2448
+ (oas-collectionFormat): csv
2449
+ uriParameters:
2450
+ contentTypeFQN:
2451
+ type: string
2452
+ required: true
2453
+ /contents/variants/{variantId}:
2454
+ get:
2455
+ description: Gets a managed content variant by Id.
2456
+ responses:
2457
+ '200':
2458
+ description: Success
2459
+ body:
2460
+ application/json:
2461
+ type: ManagedContentVariantRepresentation
2462
+ put:
2463
+ description: Replace a managed content variant.
2464
+ responses:
2465
+ '200':
2466
+ description: Success
2467
+ body:
2468
+ application/json:
2469
+ type: ManagedContentVariantRepresentation
2470
+ body:
2471
+ application/json:
2472
+ type: ManagedContentVariantUpdateInputRepresentation
2473
+ (oas-body-name): ManagedContentVariantInputParam
2474
+ uriParameters:
2475
+ variantId:
2476
+ type: string
2477
+ required: true
2478
+ /folders:
2479
+ # TODO: Hand rolled
2480
+ # post:
2481
+ # description: Create a space folder
2482
+ # responses:
2483
+ # '200':
2484
+ # description: Success
2485
+ # body:
2486
+ # application/json:
2487
+ # type: ManagedContentSpaceFolderRepresentation
2488
+ # body:
2489
+ # application/json:
2490
+ # type: ManagedContentSpaceFolderInputRep
2491
+ # (oas-body-name): managedContentSpaceFolderInput
2492
+ /folders/{folderId}:
2493
+ delete:
2494
+ description: Delete a space folder
2495
+ responses:
2496
+ '200':
2497
+ description: Success
2498
+ get:
2499
+ description: Get information of a folder
2500
+ responses:
2501
+ '200':
2502
+ description: Success
2503
+ body:
2504
+ application/json:
2505
+ type: ManagedContentSpaceFolderDetailRepresentation
2506
+ # TODO: Hand rolled
2507
+ # patch:
2508
+ # description: Update a space folder
2509
+ # responses:
2510
+ # '200':
2511
+ # description: Success
2512
+ # body:
2513
+ # application/json:
2514
+ # type: ManagedContentSpaceFolderRepresentation
2515
+ # body:
2516
+ # application/json:
2517
+ # type: ManagedContentSpaceFolderInputRep
2518
+ # (oas-body-name): managedContentSpaceFolderInput
2519
+ uriParameters:
2520
+ folderId:
2521
+ type: string
2522
+ required: true
2523
+ /folders/{folderId}/items:
2524
+ get:
2525
+ description: Get list of folder items
2526
+ responses:
2527
+ '200':
2528
+ description: Success
2529
+ body:
2530
+ application/json:
2531
+ type: ManagedContentSpaceFolderItemCollectionRepresentation
2532
+ queryParameters:
2533
+ filter:
2534
+ type: string
2535
+ required: false
2536
+ enum:
2537
+ - Content
2538
+ - Folders
2539
+ managedContentType:
2540
+ type: string
2541
+ required: false
2542
+ page:
2543
+ type: integer
2544
+ required: false
2545
+ pageSize:
2546
+ type: integer
2547
+ required: false
2548
+ queryTerm:
2549
+ type: string
2550
+ required: false
2551
+ showPublishedOnly:
2552
+ type: boolean
2553
+ required: false
2554
+ sortBy:
2555
+ type: string
2556
+ required: false
2557
+ enum:
2558
+ - LastModified
2559
+ - Status
2560
+ - Title
2561
+ sortOrder:
2562
+ type: string
2563
+ required: false
2564
+ patch:
2565
+ description: Patch specified folder item IDs - Supporting move operation
2566
+ only
2567
+ responses:
2568
+ '200':
2569
+ description: Success
2570
+ body:
2571
+ application/json:
2572
+ type: ManagedContentSpaceFolderItemCollectionRepresentation
2573
+ body:
2574
+ application/json:
2575
+ type: ManagedContentSpaceFolderItemCollectionInputRep
2576
+ (oas-body-name): folderItemsPatchInput
2577
+ uriParameters:
2578
+ folderId:
2579
+ type: string
2580
+ required: true
2581
+ /schedules:
2582
+ # TODO: Hand rolled
2583
+ # post:
2584
+ # description: Create a schedule for a deployment
2585
+ # responses:
2586
+ # '200':
2587
+ # description: Success
2588
+ # body:
2589
+ # application/json:
2590
+ # type: ManagedContentDeploymentRepresentation
2591
+ # body:
2592
+ # application/json:
2593
+ # type: ManagedContentScheduleInputRepresentation
2594
+ # (oas-body-name): ScheduleInput
2595
+ /schedules/{deploymentId}:
2596
+ # TODO: Hand rolled
2597
+ # patch:
2598
+ # description: Patch schedule date or cancel the specified scheduled deployment
2599
+ # responses:
2600
+ # '200':
2601
+ # description: Success
2602
+ # body:
2603
+ # application/json:
2604
+ # type: ManagedContentDeploymentRepresentation
2605
+ # queryParameters:
2606
+ # isCancelled:
2607
+ # type: boolean
2608
+ # required: false
2609
+ # scheduleDate:
2610
+ # type: string
2611
+ # required: false
2612
+ uriParameters:
2613
+ deploymentId:
2614
+ type: string
2615
+ required: true
2616
+ /communities/{communityId}/managed-content/delivery:
2617
+ get:
2618
+ description: Get list of managed content versions.
2619
+ responses:
2620
+ '200':
2621
+ description: Success
2622
+ body:
2623
+ application/json:
2624
+ type: ManagedContentVersionCollectionRepresentation
2625
+ queryParameters:
2626
+ contentKeys:
2627
+ type: array
2628
+ required: false
2629
+ items:
2630
+ type: string
2631
+ (oas-collectionFormat): csv
2632
+ language:
2633
+ type: string
2634
+ required: false
2635
+ managedContentIds:
2636
+ type: array
2637
+ required: false
2638
+ items:
2639
+ type: string
2640
+ (oas-collectionFormat): csv
2641
+ managedContentType:
2642
+ type: string
2643
+ required: false
2644
+ page:
2645
+ type: integer
2646
+ required: false
2647
+ pageSize:
2648
+ type: integer
2649
+ required: false
2650
+ showAbsoluteUrl:
2651
+ type: boolean
2652
+ required: false
2653
+ topics:
2654
+ type: array
2655
+ required: false
2656
+ items:
2657
+ type: string
2658
+ (oas-collectionFormat): csv
2659
+ uriParameters:
2660
+ communityId:
2661
+ type: string
2662
+ required: true
2663
+ /communities/{communityId}/managed-content/delivery/contents:
2664
+ get:
2665
+ description: Get list of managed content versions.
2666
+ responses:
2667
+ '200':
2668
+ description: Success
2669
+ body:
2670
+ application/json:
2671
+ type: ManagedContentVersionInternalCollectionRepresentation
2672
+ queryParameters:
2673
+ collectionName:
2674
+ type: string
2675
+ required: false
2676
+ contentKeys:
2677
+ type: array
2678
+ required: false
2679
+ items:
2680
+ type: string
2681
+ (oas-collectionFormat): csv
2682
+ language:
2683
+ type: string
2684
+ required: false
2685
+ managedContentIds:
2686
+ type: array
2687
+ required: false
2688
+ items:
2689
+ type: string
2690
+ (oas-collectionFormat): csv
2691
+ managedContentType:
2692
+ type: string
2693
+ required: false
2694
+ page:
2695
+ type: integer
2696
+ required: false
2697
+ pageSize:
2698
+ type: integer
2699
+ required: false
2700
+ queryTerm:
2701
+ type: string
2702
+ required: false
2703
+ topics:
2704
+ type: array
2705
+ required: false
2706
+ items:
2707
+ type: string
2708
+ (oas-collectionFormat): csv
2709
+ urlNameInList:
2710
+ type: array
2711
+ required: false
2712
+ items:
2713
+ type: string
2714
+ (oas-collectionFormat): csv
2715
+ uriParameters:
2716
+ communityId:
2717
+ type: string
2718
+ required: true
2719
+ /communities/{communityId}/managed-content/delivery/contents/search:
2720
+ get:
2721
+ description: Get the contents related to search terms
2722
+ responses:
2723
+ '200':
2724
+ description: Success
2725
+ body:
2726
+ application/json:
2727
+ type: ManagedContentSearchResultCollectionRepresentation
2728
+ queryParameters:
2729
+ page:
2730
+ type: integer
2731
+ required: false
2732
+ pageSize:
2733
+ type: integer
2734
+ required: false
2735
+ queryTerm:
2736
+ type: string
2737
+ required: false
2738
+ scope:
2739
+ type: string
2740
+ required: false
2741
+ enum:
2742
+ - All
2743
+ - TitleOnly
2744
+ uriParameters:
2745
+ communityId:
2746
+ type: string
2747
+ required: true
2748
+ /managed-content:
2749
+ /content-spaces/{contentSpaceId}:
2750
+ /content-versions:
2751
+ # TODO: Hand rolled
2752
+ # post:
2753
+ # description: Create a manage content version
2754
+ # responses:
2755
+ # '200':
2756
+ # description: Success
2757
+ # body:
2758
+ # application/json:
2759
+ # type: ManagedContentVersionInternalRepresentation
2760
+ # body:
2761
+ # application/json:
2762
+ # type: ManagedContentVersionInputRep
2763
+ # (oas-body-name): contentVersion
2764
+ uriParameters:
2765
+ contentSpaceId:
2766
+ type: string
2767
+ required: true
2768
+ /content-versions/{managedContentVersionId}:
2769
+ get:
2770
+ description: Get a single managed content version
2771
+ responses:
2772
+ '200':
2773
+ description: Success
2774
+ body:
2775
+ application/json:
2776
+ type: ManagedContentVersionInternalRepresentation
2777
+ queryParameters:
2778
+ language:
2779
+ type: string
2780
+ required: false
2781
+ # TODO: Hand rolled
2782
+ # patch:
2783
+ # description: Update a managed content version
2784
+ # responses:
2785
+ # '200':
2786
+ # description: Success
2787
+ # body:
2788
+ # application/json:
2789
+ # type: ManagedContentVersionInternalRepresentation
2790
+ # body:
2791
+ # application/json:
2792
+ # type: ManagedContentVersionInputRep
2793
+ # (oas-body-name): contentVersion
2794
+ uriParameters:
2795
+ contentSpaceId:
2796
+ type: string
2797
+ required: true
2798
+ managedContentVersionId:
2799
+ type: string
2800
+ required: true
2801
+ /contents/{managedContentId}:
2802
+ delete:
2803
+ description: Delete a nonpublished managed content given its Id
2804
+ responses:
2805
+ '200':
2806
+ description: Success
2807
+ patch:
2808
+ description: Update a managed content
2809
+ responses:
2810
+ '200':
2811
+ description: Success
2812
+ body:
2813
+ application/json:
2814
+ type: ManagedContentRepresentation
2815
+ body:
2816
+ application/json:
2817
+ type: ManagedContentInputRep
2818
+ (oas-body-name): contentVersion
2819
+ uriParameters:
2820
+ contentSpaceId:
2821
+ type: string
2822
+ required: true
2823
+ managedContentId:
2824
+ type: string
2825
+ required: true
2826
+ /members:
2827
+ get:
2828
+ description: Get the members of a content space
2829
+ responses:
2830
+ '200':
2831
+ description: Success
2832
+ body:
2833
+ application/json:
2834
+ type: ManagedContentSpaceMemberCollectionRepresentation
2835
+ # TODO: Hand rolled
2836
+ # post:
2837
+ # description: Add a member with a role to a content space
2838
+ # responses:
2839
+ # '200':
2840
+ # description: Success
2841
+ # body:
2842
+ # application/json:
2843
+ # type: ManagedContentSpaceMemberRepresentation
2844
+ # body:
2845
+ # application/json:
2846
+ # type: ManagedContentSpaceMemberInputRepresentation
2847
+ # (oas-body-name): member
2848
+ uriParameters:
2849
+ contentSpaceId:
2850
+ type: string
2851
+ required: true
2852
+ /members/{memberIdOrMe}:
2853
+ delete:
2854
+ description: Delete the membership in a content space for a member
2855
+ responses:
2856
+ '200':
2857
+ description: Success
2858
+ # TODO: Hand rolled
2859
+ # patch:
2860
+ # description: Update the membership in a content space for a member with
2861
+ # a new role
2862
+ # responses:
2863
+ # '200':
2864
+ # description: Success
2865
+ # body:
2866
+ # application/json:
2867
+ # type: ManagedContentSpaceMemberRepresentation
2868
+ # body:
2869
+ # application/json:
2870
+ # type: ManagedContentSpaceMemberInputRepresentation
2871
+ # (oas-body-name): member
2872
+ uriParameters:
2873
+ contentSpaceId:
2874
+ type: string
2875
+ required: true
2876
+ memberIdOrMe:
2877
+ type: string
2878
+ required: true
2879
+ /members/{memberIdOrMe}/permissions:
2880
+ get:
2881
+ description: Get the permissions for a member in a content space
2882
+ responses:
2883
+ '200':
2884
+ description: Success
2885
+ body:
2886
+ application/json:
2887
+ type: ManagedContentSpaceMemberPermissionsRepresentation
2888
+ uriParameters:
2889
+ contentSpaceId:
2890
+ type: string
2891
+ required: true
2892
+ memberIdOrMe:
2893
+ type: string
2894
+ required: true
2895
+ /roles:
2896
+ get:
2897
+ description: Get the roles available in a content space
2898
+ responses:
2899
+ '200':
2900
+ description: Success
2901
+ body:
2902
+ application/json:
2903
+ type: ManagedContentSpaceRoleCollectionRepresentation
2904
+ queryParameters:
2905
+ roleQueryScope:
2906
+ type: string
2907
+ required: false
2908
+ enum:
2909
+ - AuthoringRole
2910
+ - SiteRole
2911
+ /translation:
2912
+ # TODO: Hand rolled
2913
+ # post:
2914
+ # description: Create a translation job
2915
+ # responses:
2916
+ # '200':
2917
+ # description: Success
2918
+ # body:
2919
+ # application/json:
2920
+ # type: ManagedContentTranslationRepresentation
2921
+ # body:
2922
+ # application/json:
2923
+ # type: ManagedContentTranslationRequestInputRep
2924
+ # (oas-body-name): translationRequest