@salesforce/lds-adapters-cms-delivery 0.131.0

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 (123) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/cms-delivery.js +2501 -0
  3. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +66 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getCollectionItemsForChannel.d.ts +28 -0
  5. package/dist/es/es2018/types/src/generated/adapters/getCollectionItemsForSite.d.ts +28 -0
  6. package/dist/es/es2018/types/src/generated/adapters/getCollectionMetadataForChannel.d.ts +29 -0
  7. package/dist/es/es2018/types/src/generated/adapters/getCollectionMetadataForSite.d.ts +29 -0
  8. package/dist/es/es2018/types/src/generated/adapters/listContent.d.ts +34 -0
  9. package/dist/es/es2018/types/src/generated/adapters/listContentInternal.d.ts +36 -0
  10. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +6 -0
  11. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +13 -0
  12. package/dist/es/es2018/types/src/generated/resources/deleteConnectCmsContentJobsByJobId.d.ts +11 -0
  13. package/dist/es/es2018/types/src/generated/resources/deleteConnectManagedContentContentSpacesContentsByContentSpaceIdAndManagedContentId.d.ts +10 -0
  14. package/dist/es/es2018/types/src/generated/resources/deleteConnectManagedContentContentSpacesMembersByContentSpaceIdAndMemberIdOrMe.d.ts +10 -0
  15. package/dist/es/es2018/types/src/generated/resources/getConnectCmsChannelsSearchableContentTypesByChannelId.d.ts +19 -0
  16. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContent.d.ts +16 -0
  17. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContentJobsByJobId.d.ts +15 -0
  18. package/dist/es/es2018/types/src/generated/resources/getConnectCmsContentVersionByManagedContentVersionId.d.ts +19 -0
  19. package/dist/es/es2018/types/src/generated/resources/getConnectCmsDeliveryChannelsCollectionsByChannelIdAndCollectionKeyOrId.d.ts +19 -0
  20. package/dist/es/es2018/types/src/generated/resources/getConnectCmsDeliveryChannelsCollectionsMetadataByChannelIdAndCollectionKeyOrId.d.ts +20 -0
  21. package/dist/es/es2018/types/src/generated/resources/getConnectCmsDeliveryChannelsContentsQueryByChannelId.d.ts +27 -0
  22. package/dist/es/es2018/types/src/generated/resources/getConnectCmsDeliveryChannelsContentsSearchByChannelId.d.ts +21 -0
  23. package/dist/es/es2018/types/src/generated/resources/getConnectCmsDeliveryChannelsMediaContentByChannelIdAndMediaGuid.d.ts +16 -0
  24. package/dist/es/es2018/types/src/generated/resources/getConnectCmsDeliveryRecordsContentsByRecordId.d.ts +22 -0
  25. package/dist/es/es2018/types/src/generated/resources/getConnectCmsFoldersByFolderId.d.ts +15 -0
  26. package/dist/es/es2018/types/src/generated/resources/getConnectCmsFoldersItemsByFolderId.d.ts +25 -0
  27. package/dist/es/es2018/types/src/generated/resources/getConnectCmsSpacesByContentSpaceId.d.ts +15 -0
  28. package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryByCommunityId.d.ts +25 -0
  29. package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryContentsByCommunityId.d.ts +27 -0
  30. package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryContentsByCommunityIdAndManagedContentId.d.ts +16 -0
  31. package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryContentsSearchByCommunityId.d.ts +21 -0
  32. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentContentSpacesContentVersionsByContentSpaceIdAndManagedContentVersionId.d.ts +19 -0
  33. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentContentSpacesMembersByContentSpaceId.d.ts +15 -0
  34. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentContentSpacesMembersPermissionsByContentSpaceIdAndMemberIdOrMe.d.ts +16 -0
  35. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentDeliveryContentsByManagedContentId.d.ts +15 -0
  36. package/dist/es/es2018/types/src/generated/resources/getConnectManagedContentRoles.d.ts +15 -0
  37. package/dist/es/es2018/types/src/generated/resources/getConnectSitesCmsDeliveryCollectionsByCollectionKeyOrIdAndSiteId.d.ts +19 -0
  38. package/dist/es/es2018/types/src/generated/resources/getConnectSitesCmsDeliveryCollectionsMetadataByCollectionKeyOrIdAndSiteId.d.ts +20 -0
  39. package/dist/es/es2018/types/src/generated/resources/patchConnectCmsChannelsSearchableContentTypesByChannelId.d.ts +13 -0
  40. package/dist/es/es2018/types/src/generated/resources/patchConnectCmsContentVersionByManagedContentVersionId.d.ts +21 -0
  41. package/dist/es/es2018/types/src/generated/resources/patchConnectCmsFoldersItemsByFolderId.d.ts +13 -0
  42. package/dist/es/es2018/types/src/generated/resources/patchConnectManagedContentContentSpacesContentVersionsByContentSpaceIdAndManagedContentVersionId.d.ts +21 -0
  43. package/dist/es/es2018/types/src/generated/resources/patchConnectManagedContentContentSpacesContentsByContentSpaceIdAndManagedContentId.d.ts +13 -0
  44. package/dist/es/es2018/types/src/generated/resources/patchConnectManagedContentContentSpacesMembersByContentSpaceIdAndMemberIdOrMe.d.ts +14 -0
  45. package/dist/es/es2018/types/src/generated/resources/postConnectCmsContentJobsImport.d.ts +14 -0
  46. package/dist/es/es2018/types/src/generated/resources/postConnectCmsContentVariant.d.ts +18 -0
  47. package/dist/es/es2018/types/src/generated/resources/postConnectCmsContentVersion.d.ts +21 -0
  48. package/dist/es/es2018/types/src/generated/resources/postConnectCmsContentVersions.d.ts +12 -0
  49. package/dist/es/es2018/types/src/generated/resources/postConnectManagedContentContentSpacesContentVersionsByContentSpaceId.d.ts +23 -0
  50. package/dist/es/es2018/types/src/generated/resources/postConnectManagedContentContentSpacesMembersByContentSpaceId.d.ts +16 -0
  51. package/dist/es/es2018/types/src/generated/resources/postConnectManagedContentTranslation.d.ts +15 -0
  52. package/dist/es/es2018/types/src/generated/resources/putConnectCmsContentVersionByManagedContentVersionId.d.ts +21 -0
  53. package/dist/es/es2018/types/src/generated/types/AbstractMCSFolderRepresentation.d.ts +41 -0
  54. package/dist/es/es2018/types/src/generated/types/ManagedContentAssociationsInputRep.d.ts +33 -0
  55. package/dist/es/es2018/types/src/generated/types/ManagedContentAssociationsRepresentation.d.ts +30 -0
  56. package/dist/es/es2018/types/src/generated/types/ManagedContentBodyInputRep.d.ts +33 -0
  57. package/dist/es/es2018/types/src/generated/types/ManagedContentChannelSummaryRepresentation.d.ts +38 -0
  58. package/dist/es/es2018/types/src/generated/types/ManagedContentChannelTargetSummaryRepresentation.d.ts +29 -0
  59. package/dist/es/es2018/types/src/generated/types/ManagedContentCollectionItemRepresentation.d.ts +42 -0
  60. package/dist/es/es2018/types/src/generated/types/ManagedContentCollectionItemTypeSummaryRepresentation.d.ts +32 -0
  61. package/dist/es/es2018/types/src/generated/types/ManagedContentCollectionItemsRepresentation.d.ts +59 -0
  62. package/dist/es/es2018/types/src/generated/types/ManagedContentCollectionMetadataRepresentation.d.ts +66 -0
  63. package/dist/es/es2018/types/src/generated/types/ManagedContentCollectionRepresentation.d.ts +30 -0
  64. package/dist/es/es2018/types/src/generated/types/ManagedContentDateAndTimeNodeValueRepresentation.d.ts +34 -0
  65. package/dist/es/es2018/types/src/generated/types/ManagedContentDateNodeValueRepresentation.d.ts +31 -0
  66. package/dist/es/es2018/types/src/generated/types/ManagedContentDetailCollectionRepresentation.d.ts +33 -0
  67. package/dist/es/es2018/types/src/generated/types/ManagedContentDetailRepresentation.d.ts +38 -0
  68. package/dist/es/es2018/types/src/generated/types/ManagedContentInputRep.d.ts +29 -0
  69. package/dist/es/es2018/types/src/generated/types/ManagedContentJobRepresentation.d.ts +65 -0
  70. package/dist/es/es2018/types/src/generated/types/ManagedContentJobRequestInputRepresentation.d.ts +35 -0
  71. package/dist/es/es2018/types/src/generated/types/ManagedContentMediaNodeValueRepresentation.d.ts +57 -0
  72. package/dist/es/es2018/types/src/generated/types/ManagedContentMediaSourceNodeValueRepresentation.d.ts +51 -0
  73. package/dist/es/es2018/types/src/generated/types/ManagedContentNodeTypeRepresentation.d.ts +35 -0
  74. package/dist/es/es2018/types/src/generated/types/ManagedContentNodeValueRepresentation.d.ts +35 -0
  75. package/dist/es/es2018/types/src/generated/types/ManagedContentRepresentation.d.ts +35 -0
  76. package/dist/es/es2018/types/src/generated/types/ManagedContentSearchResultCollectionRepresentation.d.ts +39 -0
  77. package/dist/es/es2018/types/src/generated/types/ManagedContentSearchResultContentTypeRepresentation.d.ts +32 -0
  78. package/dist/es/es2018/types/src/generated/types/ManagedContentSearchResultRepresentation.d.ts +45 -0
  79. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderDetailRepresentation.d.ts +44 -0
  80. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderItemCollectionInputRep.d.ts +32 -0
  81. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderItemCollectionRepresentation.d.ts +36 -0
  82. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderItemRepresentation.d.ts +62 -0
  83. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceFolderRepresentation.d.ts +27 -0
  84. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberCollectionRepresentation.d.ts +30 -0
  85. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberInputRepresentation.d.ts +32 -0
  86. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberPermissionsRepresentation.d.ts +38 -0
  87. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceMemberRepresentation.d.ts +35 -0
  88. package/dist/es/es2018/types/src/generated/types/ManagedContentSpacePermissionRepresentation.d.ts +47 -0
  89. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceRepresentation.d.ts +56 -0
  90. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceRoleCollectionRepresentation.d.ts +30 -0
  91. package/dist/es/es2018/types/src/generated/types/ManagedContentSpaceRoleRepresentation.d.ts +35 -0
  92. package/dist/es/es2018/types/src/generated/types/ManagedContentTextNodeValueRepresentation.d.ts +31 -0
  93. package/dist/es/es2018/types/src/generated/types/ManagedContentTranslationRepresentation.d.ts +65 -0
  94. package/dist/es/es2018/types/src/generated/types/ManagedContentTranslationRequestInputRep.d.ts +38 -0
  95. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeRepresentation.d.ts +40 -0
  96. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSearchableCollectionRepresentation.d.ts +39 -0
  97. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSearchableInputRepresentation.d.ts +32 -0
  98. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSearchableRepresentation.d.ts +38 -0
  99. package/dist/es/es2018/types/src/generated/types/ManagedContentTypeSummaryRepresentation.d.ts +32 -0
  100. package/dist/es/es2018/types/src/generated/types/ManagedContentVariantInputRep.d.ts +47 -0
  101. package/dist/es/es2018/types/src/generated/types/ManagedContentVariantRepresentation.d.ts +50 -0
  102. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionCollectionRepresentation.d.ts +51 -0
  103. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionInputRep.d.ts +51 -0
  104. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionInternalCollectionRepresentation.d.ts +42 -0
  105. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionInternalRepresentation.d.ts +82 -0
  106. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionRepresentation.d.ts +67 -0
  107. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2CollectionInputRepresentation.d.ts +29 -0
  108. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2CollectionRepresentation.d.ts +33 -0
  109. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2InputRepresentation.d.ts +54 -0
  110. package/dist/es/es2018/types/src/generated/types/ManagedContentVersionV2Representation.d.ts +72 -0
  111. package/dist/es/es2018/types/src/generated/types/ReferenceRepresentation.d.ts +32 -0
  112. package/dist/es/es2018/types/src/generated/types/StreamedRepresentation.d.ts +26 -0
  113. package/dist/es/es2018/types/src/generated/types/TopicSummaryRepresentation.d.ts +32 -0
  114. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +39 -0
  115. package/dist/es/es2018/types/src/raml-artifacts/adapters/getCollectionItemsForChannel/onFetchResponseSuccess.d.ts +5 -0
  116. package/dist/es/es2018/types/src/raml-artifacts/adapters/getCollectionItemsForSite/onFetchResponseSuccess.d.ts +5 -0
  117. package/dist/es/es2018/types/src/raml-artifacts/adapters/getCollectionMetadataForChannel/onFetchResponseSuccess.d.ts +5 -0
  118. package/dist/es/es2018/types/src/raml-artifacts/adapters/getCollectionMetadataForSite/onFetchResponseSuccess.d.ts +5 -0
  119. package/package.json +54 -0
  120. package/sfdc/index.d.ts +1 -0
  121. package/sfdc/index.js +2573 -0
  122. package/src/raml/api.raml +2091 -0
  123. package/src/raml/luvio.raml +47 -0
@@ -0,0 +1,2091 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '52.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v58.0
10
+ securitySchemes:
11
+ OAuth2:
12
+ type: OAuth 2.0
13
+ settings:
14
+ authorizationUri: https://example.com/oauth/authorize
15
+ accessTokenUri: ''
16
+ authorizationGrants:
17
+ - implicit
18
+ annotationTypes:
19
+ oas-readOnly:
20
+ type: boolean
21
+ allowedTargets: TypeDeclaration
22
+ oas-collectionFormat:
23
+ type: string
24
+ oas-body-name:
25
+ type: string
26
+ allowedTargets: TypeDeclaration
27
+ types:
28
+ 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
+ ManagedContentAssociationsInputRep:
44
+ description: "Input Representation for associations for managed content. Describes\
45
+ \ how \n * a ManagedContent is organized. Examples are the list of topics that\
46
+ \ are \n * assigned to a ManagedContent and the folders in which the ManagedContent\
47
+ \ is placed. "
48
+ type: object
49
+ properties:
50
+ topics:
51
+ description: The names of topics to associate the Managed Content with. Set
52
+ to empty to remove all topic associations from the Managed Content.
53
+ type: array
54
+ items:
55
+ type: string
56
+ ManagedContentAssociationsRepresentation:
57
+ description: The Managed Content Associations, e.g. topic associations, describing
58
+ how this Managed Content is organized and discoverable
59
+ type: object
60
+ properties:
61
+ topics:
62
+ description: A collection of topics associated with this Managed Content.
63
+ type: array
64
+ items:
65
+ type: TopicSummaryRepresentation
66
+ ManagedContentBodyInputRep:
67
+ description: Input representation for the body of a managed content.
68
+ type: object
69
+ properties:
70
+ nodeMap:
71
+ description: The body of the managed content version.
72
+ type: object
73
+ properties:
74
+ //:
75
+ type: object
76
+ ManagedContentChannelSummaryRepresentation:
77
+ description: Contextual Information of the channel in managed content delivery
78
+ api
79
+ type: object
80
+ properties:
81
+ domainUrl:
82
+ description: Domain Url of the org
83
+ type: string
84
+ required: false
85
+ name:
86
+ description: Name of the managed content channel
87
+ type: string
88
+ resourceUrl:
89
+ description: Resource Url to fetch complete information of the channel
90
+ type: string
91
+ targetSummary:
92
+ description: Information of the Target Entity associated with this channel
93
+ type: ManagedContentChannelTargetSummaryRepresentation
94
+ required: false # TODO W-8891123 Hand rolled
95
+ ManagedContentChannelTargetSummaryRepresentation:
96
+ description: Contextual Information of the channel in managed content delivery
97
+ api
98
+ type: object
99
+ properties:
100
+ id:
101
+ description: Id of the target entity associated with the channel
102
+ type: string
103
+ ManagedContentCollectionItemRepresentation:
104
+ description: Compact information about a content.
105
+ type: object
106
+ properties:
107
+ body:
108
+ description: Get the content body of collection item
109
+ type: object
110
+ properties:
111
+ //:
112
+ type: any # TODO W-8863405 Hand Rolled
113
+ contentType:
114
+ description: The type of the collection item.
115
+ type: ManagedContentCollectionItemTypeSummaryRepresentation
116
+ id:
117
+ description: The unique identifier of collection item.
118
+ type: string
119
+ name:
120
+ description: The name or title for collection item
121
+ type: string
122
+ ManagedContentCollectionItemTypeSummaryRepresentation:
123
+ description: Information about a collection item type.
124
+ type: object
125
+ properties:
126
+ fullyQualifiedName:
127
+ description: Fully qualified name of collection item type.
128
+ type: string
129
+ name:
130
+ description: Name of collection item type.
131
+ type: string
132
+ ManagedContentCollectionItemsRepresentation:
133
+ description: Information about collection Items.
134
+ type: object
135
+ properties:
136
+ channelInfo:
137
+ description: The contextual information of the managed content channel
138
+ type: ManagedContentChannelSummaryRepresentation
139
+ collectionKey:
140
+ description: The collection key
141
+ type: string
142
+ collectionType:
143
+ description: Type of the collection.
144
+ type: ManagedContentTypeSummaryRepresentation
145
+ id:
146
+ description: The id of the collection
147
+ type: string
148
+ items:
149
+ description: Collection Items for this page.
150
+ type: array
151
+ items:
152
+ type: ManagedContentCollectionItemRepresentation
153
+ language:
154
+ description: language of the collection.
155
+ type: string
156
+ publishedDate:
157
+ description: Published Date of the collection.
158
+ type: string
159
+ title:
160
+ description: Title of the collection.
161
+ type: string
162
+ total:
163
+ description: Total number of items in current collection detail page.
164
+ type: integer
165
+ urlName:
166
+ description: URL Name of the collection.
167
+ type: string
168
+ ManagedContentCollectionMetadataRepresentation:
169
+ description: Collection Metadata.
170
+ type: object
171
+ properties:
172
+ channelInfo:
173
+ description: The contextual information of the channel
174
+ type: ManagedContentChannelSummaryRepresentation
175
+ collectionKey:
176
+ description: Globally unique identifier of a collection and doesn't change
177
+ when collection is moved between production and sandbox environments.
178
+ type: string
179
+ collectionMetadata:
180
+ description: The basic metadata of the collection
181
+ type: object
182
+ properties:
183
+ //:
184
+ type: any # TODO W-8863405 Hand Rolled
185
+ collectionType:
186
+ description: The type of collection.
187
+ type: ManagedContentTypeSummaryRepresentation
188
+ id:
189
+ description: Id of the collection.
190
+ type: string
191
+ language:
192
+ description: The language of the collection.
193
+ type: string
194
+ publishedDate:
195
+ description: The last time the collection has been published.
196
+ type: string
197
+ schema:
198
+ description: The expanded type metadata of the collection
199
+ type: object
200
+ properties:
201
+ //:
202
+ type: any # TODO W-8863405 Hand Rolled
203
+ title:
204
+ description: The title of the collection.
205
+ type: string
206
+ urlName:
207
+ description: The content url name of the collection.
208
+ type: string
209
+ ManagedContentCollectionRepresentation:
210
+ description: The output representation of a list of contents
211
+ type: object
212
+ properties:
213
+ contents:
214
+ description: List of contents
215
+ type: array
216
+ items:
217
+ type: ManagedContentRepresentation
218
+ ManagedContentDateAndTimeNodeValueRepresentation:
219
+ description: Information about a managed content node of datetime type.
220
+ discriminatorValue: Date # TODO: hand rolled
221
+ type: ManagedContentNodeValueRepresentation
222
+ properties:
223
+ dateTimeValue:
224
+ description: The DateTime value in UTC of the managed content node.
225
+ type: string
226
+ timeZone:
227
+ description: The TimeZone in which DateTime is authored of the managed content
228
+ node.
229
+ type: string
230
+ ManagedContentDateNodeValueRepresentation:
231
+ description: Information about a managed content node of type date.
232
+ discriminatorValue: Date # TODO: hand rolled
233
+ type: ManagedContentNodeValueRepresentation
234
+ properties:
235
+ value:
236
+ description: The date value of the managed content node.
237
+ type: string
238
+ ManagedContentDetailCollectionRepresentation:
239
+ description: Collection of ManagedContentDetailCollection
240
+ type: object
241
+ properties:
242
+ managedContentRecords:
243
+ description: Managed Content Details
244
+ type: array
245
+ items:
246
+ type: ManagedContentDetailRepresentation
247
+ totalItem:
248
+ description: Total count of records
249
+ type: integer
250
+ ManagedContentDetailRepresentation:
251
+ description: Details of a Managed Content
252
+ type: object
253
+ properties:
254
+ contentKey:
255
+ description: Content Key
256
+ type: string
257
+ managedContentId:
258
+ description: Id of the Managed Content
259
+ type: string
260
+ managedContentSpaceId:
261
+ description: Id Managed Content Space
262
+ type: string
263
+ managedContentVersionId:
264
+ description: Id of the Managed Content Version
265
+ type: string
266
+ ManagedContentInputRep:
267
+ description: Input representation for a managed content
268
+ type: object
269
+ properties:
270
+ publishedVersionId:
271
+ description: The published version id of the managed content.
272
+ type: string
273
+ ManagedContentJobRepresentation:
274
+ description: Information about a managed content import/export job
275
+ type: object
276
+ properties:
277
+ createdBy:
278
+ description: The user id who created the managed content job
279
+ type: string
280
+ createdDate:
281
+ description: The created date of the managed content job
282
+ type: string
283
+ errorBodyUrl:
284
+ description: The URL to get the error content body of a managed content job
285
+ type: string
286
+ id:
287
+ description: The id of a managed content job
288
+ type: string
289
+ inputBodyUrl:
290
+ description: The URL to get the input content body of a managed content job
291
+ type: string
292
+ jobType:
293
+ description: The type of a managed content job
294
+ type: string
295
+ enum:
296
+ - Export
297
+ - Import
298
+ lastModifiedBy:
299
+ description: The last user id who has modified the managed content job
300
+ type: string
301
+ lastModifiedDate:
302
+ description: The last time the managed content job has been modified
303
+ type: string
304
+ lastStatusUpdateDate:
305
+ description: The last status update date of a managed content job
306
+ type: string
307
+ name:
308
+ description: The name of a managed content job
309
+ type: string
310
+ outputBodyUrl:
311
+ description: The URL to get the output content body of a managed content job
312
+ type: string
313
+ startDate:
314
+ description: The start date of a managed content job
315
+ type: string
316
+ status:
317
+ description: The status of a managed content job
318
+ type: string
319
+ enum:
320
+ - Completed
321
+ - CompletedWithError
322
+ - Created
323
+ - Failed
324
+ - Pending
325
+ - Processing
326
+ ManagedContentJobRequestInputRepresentation:
327
+ description: Input representation for creating a ManagedContent import/export
328
+ job
329
+ type: object
330
+ properties:
331
+ contentBodyId:
332
+ description: ContentBody Id of Managed Content Import data
333
+ type: string
334
+ contentSpaceId:
335
+ description: Managed Content Space Id
336
+ type: string
337
+ name:
338
+ description: Managed Content Job Name
339
+ type: string
340
+ ManagedContentMediaNodeValueRepresentation:
341
+ description: Information about a managed content node of media type.
342
+ type: ManagedContentNodeValueRepresentation
343
+ properties:
344
+ altText:
345
+ description: The alternate text for the managed content node.
346
+ type: string
347
+ contentKey:
348
+ description: The contentKey of managed content being referenced.
349
+ type: string
350
+ fileName:
351
+ description: The file name of the managed content node.
352
+ type: string
353
+ mediaType:
354
+ description: The media type of the managed content node like Image, Video
355
+ or Document
356
+ type: string
357
+ enum:
358
+ - Document
359
+ - Image
360
+ - Video
361
+ mimeType:
362
+ description: The mime type of the managed content node.
363
+ type: string
364
+ resourceUrl:
365
+ description: The resource url of the managed content node.
366
+ type: string
367
+ thumbnailUrl:
368
+ description: Media thumbnail url.
369
+ type: string
370
+ title:
371
+ description: The title of the managed content node.
372
+ type: string
373
+ unauthenticatedUrl:
374
+ description: The unauthenticated url of the managed content node.
375
+ type: string
376
+ url:
377
+ description: The url of the managed content node.
378
+ type: string
379
+ ManagedContentMediaSourceNodeValueRepresentation:
380
+ description: Information about a source of a managed content media.
381
+ type: ManagedContentNodeValueRepresentation
382
+ properties:
383
+ fileName:
384
+ description: The file name of the media source.
385
+ type: string
386
+ isExternal:
387
+ description: Whether media source is uploaded or referenced via external url.
388
+ type: boolean
389
+ mediaType:
390
+ description: The type of media like Image, Video or Document.
391
+ type: string
392
+ enum:
393
+ - Document
394
+ - Image
395
+ - Video
396
+ mimeType:
397
+ description: The mime type of the media source.
398
+ type: string
399
+ referenceId:
400
+ description: Reference id of the uploaded media source
401
+ type: string
402
+ resourceUrl:
403
+ description: The API url to the bytes of the media source.
404
+ type: string
405
+ unauthenticatedUrl:
406
+ description: The url to the bytes of the media source for unauthenticated
407
+ users.
408
+ type: string
409
+ url:
410
+ description: The url to the bytes of the source for authenticated users.
411
+ type: string
412
+ ManagedContentNodeTypeRepresentation:
413
+ description: Information about a managed content node type.
414
+ type: object
415
+ properties:
416
+ label:
417
+ description: The label of the managed content node type.
418
+ type: string
419
+ name:
420
+ description: The developer name of the managed content node type.
421
+ type: string
422
+ nodeType:
423
+ description: The type of the managed content node.
424
+ type: string
425
+ enum:
426
+ - Date
427
+ - DateTime
428
+ - Media
429
+ - MediaSource
430
+ - MultilineText
431
+ - NameField
432
+ - RichText
433
+ - Text
434
+ - Url
435
+ ManagedContentNodeValueRepresentation:
436
+ description: Information about a managed content node.
437
+ discriminator: nodeType # TODO: hand rolled
438
+ type: object
439
+ properties:
440
+ nodeType:
441
+ description: The type of the managed content node.
442
+ type: string
443
+ enum:
444
+ - Date
445
+ - DateTime
446
+ - Media
447
+ - MediaSource
448
+ - MultilineText
449
+ - NameField
450
+ - RichText
451
+ - Text
452
+ - Url
453
+ ManagedContentRepresentation:
454
+ description: Information about a managed content.
455
+ type: object
456
+ properties:
457
+ contentKey:
458
+ description: Content key of the Managed Content.
459
+ type: string
460
+ id:
461
+ description: Response record Id
462
+ type: string
463
+ publishedVersionId:
464
+ description: Id of the published managed content version, or null if there
465
+ isn't one
466
+ type: string
467
+ ManagedContentSearchResultCollectionRepresentation:
468
+ description: A container of paginated cms keyword-based search result items plus
469
+ a short search result summary
470
+ type: object
471
+ properties:
472
+ count:
473
+ description: total search result item count
474
+ type: integer
475
+ currentPageUri:
476
+ description: search result URI
477
+ type: string
478
+ items:
479
+ description: an array of search result items
480
+ type: array
481
+ items:
482
+ type: ManagedContentSearchResultRepresentation
483
+ nextPageUri:
484
+ description: next search result URI
485
+ type: string
486
+ ManagedContentSearchResultContentTypeRepresentation:
487
+ description: A keyword-based search result item's content type
488
+ type: object
489
+ properties:
490
+ developerName:
491
+ description: managed content type developer name
492
+ type: string
493
+ label:
494
+ description: managed content type label
495
+ type: string
496
+ ManagedContentSearchResultRepresentation:
497
+ description: A keyword-based search result item
498
+ type: object
499
+ properties:
500
+ contentKey:
501
+ description: managed content content key
502
+ type: string
503
+ contentType:
504
+ description: managed content content type
505
+ type: ManagedContentSearchResultContentTypeRepresentation
506
+ id:
507
+ description: managed content id
508
+ type: string
509
+ publishDate:
510
+ description: managed content published date
511
+ type: string
512
+ title:
513
+ description: managed content title
514
+ type: string
515
+ urlName:
516
+ description: managed content (version) url name
517
+ type: string
518
+ ManagedContentSpaceFolderDetailRepresentation:
519
+ description: Detail Representation of a CMS Folder i.e. ManagedContentSpaceFolder
520
+ discriminatorValue: FolderDetail # TODO: hand rolled
521
+ type: AbstractMCSFolderRepresentation
522
+ properties:
523
+ createdBy:
524
+ description: The User ID of the user who created the folder
525
+ type: string
526
+ createdDate:
527
+ description: The date when the folder was created
528
+ type: string
529
+ folderHierarchy:
530
+ description: The list of the parent folders in the hierarchy - starting from
531
+ the root upto the direct parent of the folder
532
+ type: array
533
+ items:
534
+ type: ManagedContentSpaceFolderRepresentation
535
+ lastModifiedBy:
536
+ description: The User ID of the user who last modified the folder
537
+ type: string
538
+ lastModifiedDate:
539
+ description: The date when the folder was last modified
540
+ type: string
541
+ ManagedContentSpaceFolderItemCollectionInputRep:
542
+ description: Collection input of ManagedContentSpaceFolderItems for Move operation
543
+ type: object
544
+ properties:
545
+ folderId:
546
+ description: ID of the new parent folder to the items should be moved
547
+ type: string
548
+ folderItems:
549
+ description: List of IDs of the folder items that need to be moved
550
+ type: array
551
+ items:
552
+ type: string
553
+ ManagedContentSpaceFolderItemCollectionRepresentation:
554
+ description: Collection Representation of folder items inside in ManagedContentSpaceFolder
555
+ type: object
556
+ properties:
557
+ folderId:
558
+ description: The id of the folder
559
+ type: string
560
+ folderItems:
561
+ description: The list of the folder items - ManagedContent or ManagedContentSpaceFolder
562
+ type: array
563
+ items:
564
+ type: ManagedContentSpaceFolderItemRepresentation
565
+ parentFolderId:
566
+ description: The id of the parent folder
567
+ type: string
568
+ ManagedContentSpaceFolderItemRepresentation:
569
+ description: Representation of a folder item inside a ManagedContentSpaceFolder
570
+ type: object
571
+ properties:
572
+ createdBy:
573
+ description: The User ID for the user which created the ManagedContent or
574
+ ManagedContentSpaceFolder
575
+ type: string
576
+ createdDate:
577
+ description: The date when the ManagedContent or ManagedContentSpaceFolder
578
+ was created
579
+ type: string
580
+ hasChildFolders:
581
+ description: Boolean flag to indicate whether this folder has child folders
582
+ type: boolean
583
+ id:
584
+ description: The id of the folder item - ManagedContent or ManagedContentSpaceFolder
585
+ type: string
586
+ isFolder:
587
+ description: Boolean flag to indicate whether this folder item is a folder
588
+ type: boolean
589
+ lastModifiedBy:
590
+ description: The User ID for the user which last modified the ManagedContent
591
+ or ManagedContentSpaceFolder
592
+ type: string
593
+ lastModifiedDate:
594
+ description: The date when the ManagedContent or ManagedContentSpaceFolder
595
+ was last modified
596
+ type: string
597
+ managedContentType:
598
+ description: Developer Name for the ManagedContentType if the folder item
599
+ is ManagedContent
600
+ type: string
601
+ managedContentVersionId:
602
+ description: Latest Managed Content Version Id of the folder item is ManagedContent
603
+ type: string
604
+ publishedDate:
605
+ description: Date when the ManagedContent was last published
606
+ type: string
607
+ status:
608
+ description: Status of the Managed Content
609
+ type: string
610
+ title:
611
+ description: Title of the ManagedContent/ManagedContentSpaceFolder
612
+ type: string
613
+ ManagedContentSpaceFolderRepresentation:
614
+ description: Base Representation of a CMS Folder i.e. ManagedContentSpaceFolder
615
+ discriminatorValue: Folder # TODO: hand rolled
616
+ type: AbstractMCSFolderRepresentation
617
+ properties: {}
618
+ ManagedContentSpaceMemberCollectionRepresentation:
619
+ description: Collection representation of the members in a content space
620
+ type: object
621
+ properties:
622
+ members:
623
+ description: List of the members in the content space
624
+ type: array
625
+ items:
626
+ type: ManagedContentSpaceMemberRepresentation
627
+ ManagedContentSpaceMemberInputRepresentation:
628
+ description: Input representation of a content space member
629
+ type: object
630
+ properties:
631
+ memberId:
632
+ description: The ID of the user/group to assign the role in the content space
633
+ type: string
634
+ roleId:
635
+ description: The ID of the role to assign the user as, in the content space
636
+ type: string
637
+ ManagedContentSpaceMemberPermissionsRepresentation:
638
+ description: Representation of permissions of a member in a content space
639
+ type: object
640
+ properties:
641
+ permissions:
642
+ description: A map of permissions for a member grouped by different scopes
643
+ and consequently spaceContentTypes
644
+ type: object
645
+ properties:
646
+ //:
647
+ type: object
648
+ properties:
649
+ //:
650
+ type: ManagedContentSpacePermissionRepresentation
651
+ ManagedContentSpaceMemberRepresentation:
652
+ description: Representation of a ManagedContentSpaceMember
653
+ type: object
654
+ properties:
655
+ id:
656
+ description: The id of managedContentSpaceMember entity object
657
+ type: string
658
+ memberId:
659
+ description: The user / group id
660
+ type: string
661
+ role:
662
+ description: The role associated with the member
663
+ type: ManagedContentSpaceRoleRepresentation
664
+ ManagedContentSpacePermissionRepresentation:
665
+ description: Representation of a permission bit vector based on a scopeType or
666
+ contentTypeIdOrEnum
667
+ type: object
668
+ properties:
669
+ canCreate:
670
+ description: Does the member have create access for the scopeType and spaceContentType
671
+ type: boolean
672
+ canDelete:
673
+ description: Does the member have delete access for the scopeType and spaceContentType
674
+ type: boolean
675
+ canManage:
676
+ description: Does the member have manage access for the scopeType and spaceContentType
677
+ type: boolean
678
+ canPublish:
679
+ description: Does the member have publish/unpublish access for the scopeType
680
+ and spaceContentType
681
+ type: boolean
682
+ canRead:
683
+ description: Does the member have read access for the scopeType and spaceContentType
684
+ type: boolean
685
+ canTranslate:
686
+ description: Does the member have translate access for the scopeType and spaceContentType
687
+ type: boolean
688
+ canUpdate:
689
+ description: Does the member have update access for the scopeType and spaceContentType
690
+ type: boolean
691
+ ManagedContentSpaceRepresentation:
692
+ description: Details of a Managed Content Space
693
+ type: object
694
+ properties:
695
+ createdBy:
696
+ description: User-Id of the creator of the Managed Content Space
697
+ type: string
698
+ createdDate:
699
+ description: Date of creation of the Managed Content Space
700
+ type: string
701
+ defaultLanguage:
702
+ description: Default Language of the Managed Content Space
703
+ type: string
704
+ description:
705
+ description: Description of the Managed Content Space
706
+ type: string
707
+ id:
708
+ description: Id of the Managed Content Space
709
+ type: string
710
+ lastModifiedBy:
711
+ description: User-Id of the user who last modified the Managed Content Space
712
+ type: string
713
+ lastModifiedDate:
714
+ description: Date on which the Managed Content Space was last modified
715
+ type: string
716
+ name:
717
+ description: Name of the Managed Content Space
718
+ type: string
719
+ rootFolderId:
720
+ description: Root Folder Id of the Managed Content Space
721
+ type: string
722
+ supportedLanguages:
723
+ description: Set of supported languages in the Managed Content Space
724
+ type: array
725
+ items:
726
+ type: string
727
+ ManagedContentSpaceRoleCollectionRepresentation:
728
+ description: Collection representation of the roles in a content space
729
+ type: object
730
+ properties:
731
+ roles:
732
+ description: List of the roles in the content space
733
+ type: array
734
+ items:
735
+ type: ManagedContentSpaceRoleRepresentation
736
+ ManagedContentSpaceRoleRepresentation:
737
+ description: Representation of a ManagedContentSpaceRole
738
+ type: object
739
+ properties:
740
+ description:
741
+ description: The role description
742
+ type: string
743
+ id:
744
+ description: The role ID
745
+ type: string
746
+ name:
747
+ description: The role name
748
+ type: string
749
+ ManagedContentTextNodeValueRepresentation:
750
+ description: Information about a managed content node of type text.
751
+ discriminatorValue: Text # TODO: hand rolled
752
+ type: ManagedContentNodeValueRepresentation
753
+ properties:
754
+ value:
755
+ description: The text value of the managed content node.
756
+ type: string
757
+ ManagedContentTranslationRepresentation:
758
+ description: Information about a managed content translation job
759
+ type: object
760
+ properties:
761
+ createdBy:
762
+ description: The user id who created the managed content translation job
763
+ type: string
764
+ createdDate:
765
+ description: The created date of the managed content translation job
766
+ type: string
767
+ errorBodyUrl:
768
+ description: The URL to get the error content body of a managed content translation
769
+ job
770
+ type: string
771
+ id:
772
+ description: The id of a managed content translation job
773
+ type: string
774
+ inputBodyUrl:
775
+ description: The URL to get the input content body of a managed content translation
776
+ job
777
+ type: string
778
+ jobType:
779
+ description: The type of a managed content translation job
780
+ type: string
781
+ enum:
782
+ - Export
783
+ - Import
784
+ lastModifiedBy:
785
+ description: The last user id who has modified the managed content translation
786
+ job
787
+ type: string
788
+ lastModifiedDate:
789
+ description: The last time the managed content translation job has been modified
790
+ type: string
791
+ lastStatusUpdateDate:
792
+ description: The last status update date of a managed content translation
793
+ job
794
+ type: string
795
+ name:
796
+ description: The name of a managed content translation job
797
+ type: string
798
+ outputBodyUrl:
799
+ description: The URL to get the output content body of a managed content translation
800
+ job
801
+ type: string
802
+ startDate:
803
+ description: The start date of a managed content translation job
804
+ type: string
805
+ status:
806
+ description: The status of a managed content translation job
807
+ type: string
808
+ enum:
809
+ - Completed
810
+ - Created
811
+ - Failed
812
+ - Pending
813
+ - Processing
814
+ ManagedContentTranslationRequestInputRep:
815
+ description: Input representation of a translation request
816
+ type: object
817
+ properties:
818
+ contentBodyId:
819
+ description: Indicates the content body id of the translation
820
+ type: string
821
+ managedContentSpaceId:
822
+ description: Managed Content Space Id
823
+ type: string
824
+ name:
825
+ description: Indicates the name of the translation
826
+ type: string
827
+ type:
828
+ description: Indicates the type of the translation
829
+ type: string
830
+ enum:
831
+ - Export
832
+ - Import
833
+ ManagedContentTypeRepresentation:
834
+ description: Information about a managed content type.
835
+ type: object
836
+ properties:
837
+ label:
838
+ description: The label of the managed content type..
839
+ type: string
840
+ name:
841
+ description: The developer name of the managed content type.
842
+ type: string
843
+ nodeTypes:
844
+ description: The collection of node types in this managed content type..
845
+ type: object
846
+ properties:
847
+ //:
848
+ type: ManagedContentNodeTypeRepresentation
849
+ ManagedContentTypeSearchableCollectionRepresentation:
850
+ description: Collection of Content Type Search Status
851
+ type: object
852
+ properties:
853
+ currentPageUrl:
854
+ description: URL to the current page of Manage Content Type Search Status
855
+ records. The default is 25 managed content channels per page.
856
+ type: string
857
+ items:
858
+ description: Manage Content Type Searchable records corresponding to the current
859
+ page
860
+ type: array
861
+ items:
862
+ type: ManagedContentTypeSearchableRepresentation
863
+ nextPageUrl:
864
+ description: URL to the next page of Manage Content Type Search Status records.
865
+ The default is 25 managed content channels per page.
866
+ type: string
867
+ totalItems:
868
+ description: Total count of Manage Content Type Search Status records across
869
+ all pages
870
+ type: integer
871
+ ManagedContentTypeSearchableInputRepresentation:
872
+ description: The input representation for a content type search status
873
+ type: object
874
+ properties:
875
+ isSearchable:
876
+ description: Searchable status of the Content Type
877
+ type: boolean
878
+ name:
879
+ description: Name of the Content Type
880
+ type: string
881
+ ManagedContentTypeSearchableRepresentation:
882
+ description: Details of a Managed Content Type Search Status
883
+ type: object
884
+ properties:
885
+ id:
886
+ description: Id of the Managed Content Type
887
+ type: string
888
+ isSearchable:
889
+ description: Is the contentType searchable
890
+ type: boolean
891
+ label:
892
+ description: Master label of the Managed Content Type
893
+ type: string
894
+ name:
895
+ description: Developer Name of the Managed Content Type
896
+ type: string
897
+ ManagedContentVariantInputRep:
898
+ description: Input representation of a managed content variant request
899
+ type: object
900
+ properties:
901
+ body:
902
+ description: Indicates the body of a variation
903
+ type: object
904
+ language:
905
+ description: Indicates the language of a variation
906
+ type: string
907
+ managedContentVersionId:
908
+ description: Managed Content Version Id
909
+ type: string
910
+ name:
911
+ description: Indicates the name of a variation
912
+ type: string
913
+ parentId:
914
+ description: Indicates the parent id of a variation
915
+ type: string
916
+ type:
917
+ description: Indicates the type of the ManagedContentVariant
918
+ type: string
919
+ enum:
920
+ - Translation
921
+ - Variation
922
+ urlName:
923
+ description: Indicates the url name of a variation
924
+ type: string
925
+ ManagedContentTypeSummaryRepresentation:
926
+ description: Information about a managed content type.
927
+ type: object
928
+ properties:
929
+ fullyQualifiedName:
930
+ description: fully qualified name of a managed content type.
931
+ type: string
932
+ name:
933
+ description: name of a managed content type.
934
+ type: string
935
+ required: false # TODO hand rolled. W-10787385
936
+ ManagedContentVariantRepresentation:
937
+ description: Information about a managed content variant
938
+ type: object
939
+ properties:
940
+ body:
941
+ description: The body of a managed content variant
942
+ type: string
943
+ id:
944
+ description: The id of a managed content variant
945
+ type: string
946
+ language:
947
+ description: The language of a managed content variant
948
+ type: string
949
+ managedContentVersionId:
950
+ description: The id of a managed content version
951
+ type: string
952
+ name:
953
+ description: The name of a managed content variant
954
+ type: string
955
+ parentId:
956
+ description: The id of a parent
957
+ type: string
958
+ urlName:
959
+ description: The url name of a managed content variant
960
+ type: string
961
+ variantType:
962
+ description: The variant of a managed content variant
963
+ type: string
964
+ enum:
965
+ - Translation
966
+ - Variation
967
+ ManagedContentVersionCollectionRepresentation:
968
+ description: Collection of managed content versions.
969
+ type: object
970
+ properties:
971
+ currentPageUrl:
972
+ description: URL to the current page of managed content versions. The default
973
+ is 25 managed content versions per page.
974
+ type: string
975
+ items:
976
+ description: Managed content versions for this page.
977
+ type: array
978
+ items:
979
+ type: ManagedContentVersionRepresentation
980
+ managedContentTypes:
981
+ description: Managed content types for this page.
982
+ type: object
983
+ required: false # TODO W-8891123 Hand rolled
984
+ properties:
985
+ //:
986
+ type: ManagedContentTypeRepresentation
987
+ nextPageUrl:
988
+ description: URL to the next page of managed content versions, The default
989
+ is 25 managed content versions per page.
990
+ type: string
991
+ required: false # TODO W-8891123 Hand rolled
992
+ total:
993
+ description: Total number of versions across all pages.
994
+ type: integer
995
+ totalTypes:
996
+ description: Total number of content types across all pages.
997
+ type: integer
998
+ ManagedContentVersionInputRep:
999
+ description: Input representation for a managed content
1000
+ type: object
1001
+ properties:
1002
+ associations:
1003
+ description: 'Input Representation for associations for managed content. Describes
1004
+ how a ManagedContent is organized. Examples are the list of topics that
1005
+ are assigned to a ManagedContent and the folders in which the ManagedContent
1006
+ is placed. '
1007
+ type: object
1008
+ body:
1009
+ description: The body of the managed content version.
1010
+ type: object
1011
+ properties:
1012
+ //:
1013
+ type: object
1014
+ managedContentId:
1015
+ description: 'Id of a managed content id. This is only required when creating
1016
+ a new version of an already existing managed content. If this is specified
1017
+ the operation will mean “create a new version of the managed content with
1018
+ id”. '
1019
+ type: string
1020
+ spaceFolderId:
1021
+ description: Id of a ManagedContentSpaceFolder in which the Content should
1022
+ be created.
1023
+ type: string
1024
+ title:
1025
+ description: The title of the managed content version.
1026
+ type: string
1027
+ type:
1028
+ description: The type of the managed content, represents a category of content
1029
+ such as News, Blog or Story. The ManagedContentType.DeveloperName of the
1030
+ active ManagedContentTypeVersion of the ManagedContentVersion. This is always
1031
+ required.
1032
+ type: string
1033
+ urlName:
1034
+ description: A string that uniquely identifies the content within the org,
1035
+ could be used in e.g. URLs.
1036
+ type: string
1037
+ ManagedContentVersionInternalCollectionRepresentation:
1038
+ description: Collection of managed content versions.
1039
+ type: object
1040
+ properties:
1041
+ items:
1042
+ description: Managed content versions for this page.
1043
+ type: array
1044
+ items:
1045
+ type: ManagedContentVersionInternalRepresentation
1046
+ total:
1047
+ description: Total number of versions accros all pages.
1048
+ type: integer
1049
+ ManagedContentVersionInternalRepresentation:
1050
+ description: Information about a managed content version.
1051
+ type: object
1052
+ properties:
1053
+ associations:
1054
+ description: The Managed Content Associations, e.g. topic associations, describing
1055
+ how this Managed Content is organized and discoverable
1056
+ type: ManagedContentAssociationsRepresentation
1057
+ authoredManagedContentId:
1058
+ description: The unique identifer of the managed content in the authoring
1059
+ space.
1060
+ type: string
1061
+ body:
1062
+ description: Get the body
1063
+ type: object
1064
+ properties:
1065
+ //:
1066
+ type: any # TODO Hand rolled
1067
+ contentKey:
1068
+ description: The content key
1069
+ type: string
1070
+ createdByReference:
1071
+ description: Reference to the user who created the managed content version.
1072
+ type: ReferenceRepresentation
1073
+ createdDate:
1074
+ description: Get the date when the managed content version was created.
1075
+ type: string
1076
+ id:
1077
+ description: Response record Id
1078
+ type: string
1079
+ lastUpdatedByReference:
1080
+ description: Reference to the user who updated the managed content version.
1081
+ type: ReferenceRepresentation
1082
+ managedContentId:
1083
+ description: Id of the managed content that this is a version of
1084
+ type: string
1085
+ masterLanguage:
1086
+ description: Master Language of the managed content in the authoring space.
1087
+ type: string
1088
+ publishDate:
1089
+ description: Get the date when managed content version was published.
1090
+ type: string
1091
+ status:
1092
+ description: The status of the managed content version.
1093
+ type: string
1094
+ title:
1095
+ description: Get the title of the managed content version.
1096
+ type: string
1097
+ type:
1098
+ description: The type of the managed content version.
1099
+ type: string
1100
+ typeLabel:
1101
+ description: The type label of the managed content version.
1102
+ type: string
1103
+ updatedDate:
1104
+ description: Get the date when the managed content version was updated.
1105
+ type: string
1106
+ urlName:
1107
+ description: The url of the managed content version
1108
+ type: string
1109
+ ReferenceRepresentation:
1110
+ description: A reference to another record in the organization without including all of the information about that record.
1111
+ type: object
1112
+ properties:
1113
+ id:
1114
+ description: The ID of the object being referenced, which could be an 18-character ID or some other string identifier.
1115
+ type: string
1116
+ url:
1117
+ description: URL to the resource endpoint.
1118
+ type: string #TODO W-8271735 to track difference from expected object in url
1119
+ ManagedContentVersionRepresentation:
1120
+ description: Information about a managed content version.
1121
+ type: object
1122
+ properties:
1123
+ associations:
1124
+ description: The Managed Content Associations, e.g. topic associations, describing
1125
+ how this Managed Content is organized and discoverable
1126
+ type: ManagedContentAssociationsRepresentation
1127
+ required: false # TODO W-8891123 Hand rolled
1128
+ contentKey:
1129
+ description: The content key
1130
+ type: string
1131
+ contentNodes:
1132
+ description: Get the content nodes
1133
+ type: object
1134
+ properties:
1135
+ //:
1136
+ type: ManagedContentNodeValueRepresentation
1137
+ contentUrlName:
1138
+ description: The content url name of the managed content version.
1139
+ type: string
1140
+ language:
1141
+ description: The language of the managed content version.
1142
+ type: string
1143
+ managedContentId:
1144
+ description: The unique identifier of the managed content in the authoring
1145
+ space.
1146
+ type: string
1147
+ publishedDate:
1148
+ description: Get the date when the managed content version was last published.
1149
+ type: string
1150
+ title:
1151
+ description: Get the title of the managed content version.
1152
+ type: string
1153
+ type:
1154
+ description: The type of the managed content version.
1155
+ type: string
1156
+ typeLabel:
1157
+ description: The type label of the managed content type.
1158
+ type: string
1159
+ unauthenticatedUrl:
1160
+ description: Unauthenticated delivery Url
1161
+ type: string | nil # TODO W-8891091 Hand rolled
1162
+ ManagedContentVersionV2CollectionInputRepresentation:
1163
+ description: Input representation for collection of managed content version
1164
+ type: object
1165
+ properties:
1166
+ managedContentVersions:
1167
+ description: List of IDs of the ManagedContentVersion that need to be bulk
1168
+ inserted.
1169
+ type: array
1170
+ items:
1171
+ type: object
1172
+ ManagedContentVersionV2CollectionRepresentation:
1173
+ description: Collection of json based managed content versions.
1174
+ type: object
1175
+ properties:
1176
+ total:
1177
+ description: Total number of versions across all pages.
1178
+ type: integer
1179
+ versions:
1180
+ description: Managed content versions for this page.
1181
+ type: array
1182
+ items:
1183
+ type: ManagedContentVersionV2Representation
1184
+ ManagedContentVersionV2InputRepresentation:
1185
+ description: Input representation for a managed content version
1186
+ type: object
1187
+ properties:
1188
+ body:
1189
+ description: The body of the managed content version.
1190
+ type: object
1191
+ properties:
1192
+ //:
1193
+ type: object
1194
+ language:
1195
+ description: The language of the managed content version.
1196
+ type: string
1197
+ managedContentId:
1198
+ description: 'Id of a managed content id. This is only required when creating
1199
+ a new version of an already existing managed content. If this is specified
1200
+ the operation will mean “create a new version of the managed content with
1201
+ id”. '
1202
+ type: string
1203
+ name:
1204
+ description: The name of the managed content version.
1205
+ type: string
1206
+ parentContentKey:
1207
+ description: Content Key of Parent Managed Content
1208
+ type: string
1209
+ spaceId:
1210
+ description: The spaceId of the managed content version.
1211
+ type: string
1212
+ type:
1213
+ description: The type of the managed content, represents a category of content
1214
+ such as News, Blog or Story. The ManagedContentType.DeveloperName of the
1215
+ active ManagedContentTypeVersion of the ManagedContentVersion. This is always
1216
+ required.
1217
+ type: string
1218
+ urlName:
1219
+ description: A string that uniquely identifies the content within the org,
1220
+ could be used in e.g. URLs.
1221
+ type: string
1222
+ ManagedContentVersionV2Representation:
1223
+ description: Information about a managed content version.
1224
+ type: object
1225
+ properties:
1226
+ body:
1227
+ description: Get body of the managed content version.
1228
+ type: object
1229
+ properties:
1230
+ //:
1231
+ type: object
1232
+ contentKey:
1233
+ description: Content Key of the managed content.
1234
+ type: string
1235
+ createdBy:
1236
+ description: The user id who created the managed content version
1237
+ type: string
1238
+ createdDate:
1239
+ description: The created date of the managed content version
1240
+ type: string
1241
+ id:
1242
+ description: The unique identifier of the managed content version in the authoring
1243
+ space.
1244
+ type: string
1245
+ language:
1246
+ description: The master language of the managed content version.
1247
+ type: string
1248
+ lastModifiedBy:
1249
+ description: The last user id who has modified the managed content version
1250
+ type: string
1251
+ lastModifiedDate:
1252
+ description: The last time the managed content version has been modified
1253
+ type: string
1254
+ managedContentId:
1255
+ description: The unique identifier of the managed content in the authoring
1256
+ space.
1257
+ type: string
1258
+ name:
1259
+ description: Get the title of the managed content version.
1260
+ type: string
1261
+ renditionLanguage:
1262
+ description: The language of the managed content version.
1263
+ type: string
1264
+ status:
1265
+ description: Get status of the managed content version.
1266
+ type: string
1267
+ type:
1268
+ description: The type of the managed content version.
1269
+ type: string
1270
+ urlName:
1271
+ description: The content url name of the managed content version.
1272
+ type: string
1273
+ TopicSummaryRepresentation:
1274
+ description: A summary of a topic
1275
+ type: object
1276
+ properties:
1277
+ id:
1278
+ description: The ID of the topic
1279
+ type: string
1280
+ name:
1281
+ description: The name of the topic
1282
+ type: string
1283
+ StreamedRepresentation: # TODO Hand rolled
1284
+ description: streamed representation.
1285
+ type: object
1286
+ properties: {}
1287
+ /connect:
1288
+ /cms:
1289
+ /channels/{channelId}/searchable-content-types:
1290
+ get:
1291
+ description: Get searchable status of managed content types in a channel.
1292
+ responses:
1293
+ '200':
1294
+ description: Success
1295
+ body:
1296
+ application/json:
1297
+ type: ManagedContentTypeSearchableCollectionRepresentation
1298
+ queryParameters:
1299
+ page:
1300
+ type: integer
1301
+ required: false
1302
+ pageSize:
1303
+ type: integer
1304
+ required: false
1305
+ patch:
1306
+ description: Update searchable status of a managed content type
1307
+ responses:
1308
+ '200':
1309
+ description: Success
1310
+ body:
1311
+ application/json:
1312
+ type: ManagedContentTypeSearchableRepresentation
1313
+ body:
1314
+ application/json:
1315
+ type: ManagedContentTypeSearchableInputRepresentation
1316
+ (oas-body-name): contentTypeSearchInput
1317
+ uriParameters:
1318
+ channelId:
1319
+ type: string
1320
+ required: true
1321
+ /content:
1322
+ get:
1323
+ description: Get ist of managed content id and its corresponding managed content
1324
+ space ids
1325
+ responses:
1326
+ '200':
1327
+ description: Success
1328
+ body:
1329
+ application/json:
1330
+ type: ManagedContentDetailCollectionRepresentation
1331
+ queryParameters:
1332
+ contentKeys:
1333
+ type: array
1334
+ required: false
1335
+ items:
1336
+ type: string
1337
+ (oas-collectionFormat): csv
1338
+ managedContentIds:
1339
+ type: array
1340
+ required: false
1341
+ items:
1342
+ type: string
1343
+ (oas-collectionFormat): csv
1344
+ /jobs:
1345
+ /import:
1346
+ post:
1347
+ description: Create a job for importing Managed Content
1348
+ responses:
1349
+ '200':
1350
+ description: Success
1351
+ body:
1352
+ application/json:
1353
+ type: ManagedContentJobRepresentation
1354
+ body:
1355
+ application/json:
1356
+ type: ManagedContentJobRequestInputRepresentation
1357
+ (oas-body-name): managedContentJobRequest
1358
+ /{jobId}:
1359
+ delete:
1360
+ description: Delete an instance of a ManagedContentImportExportJob.
1361
+ responses:
1362
+ '200':
1363
+ description: Success
1364
+ get:
1365
+ description: Get a specific Managed Content Job (CMS Import/Export) record
1366
+ responses:
1367
+ '200':
1368
+ description: Success
1369
+ body:
1370
+ application/json:
1371
+ type: ManagedContentJobRepresentation
1372
+ uriParameters:
1373
+ jobId:
1374
+ type: string
1375
+ required: true
1376
+ /variant:
1377
+ post:
1378
+ description: Create a managed content variant
1379
+ responses:
1380
+ '200':
1381
+ description: Success
1382
+ body:
1383
+ application/json:
1384
+ type: ManagedContentVariantRepresentation
1385
+ body:
1386
+ application/json:
1387
+ type: ManagedContentVariantInputRep
1388
+ (oas-body-name): variantRequest
1389
+ /version:
1390
+ post:
1391
+ description: Create Managed Content Version for Json store
1392
+ responses:
1393
+ '200':
1394
+ description: Success
1395
+ body:
1396
+ application/json:
1397
+ type: ManagedContentVersionV2Representation
1398
+ body:
1399
+ application/json:
1400
+ type: ManagedContentVersionV2InputRepresentation
1401
+ (oas-body-name): managedContentVersionV2Request
1402
+ /version/{managedContentVersionId}:
1403
+ get:
1404
+ description: Get a single managed content version
1405
+ responses:
1406
+ '200':
1407
+ description: Success
1408
+ body:
1409
+ application/json:
1410
+ type: ManagedContentVersionV2Representation
1411
+ queryParameters:
1412
+ language:
1413
+ type: string
1414
+ required: false
1415
+ variantType:
1416
+ type: string
1417
+ required: false
1418
+ patch:
1419
+ description: Patch a single managed content version
1420
+ responses:
1421
+ '200':
1422
+ description: Success
1423
+ body:
1424
+ application/json:
1425
+ type: ManagedContentVersionV2Representation
1426
+ body:
1427
+ application/json:
1428
+ type: ManagedContentVersionV2InputRepresentation
1429
+ (oas-body-name): managedContentVersionV2Request
1430
+ put:
1431
+ description: Put a single managed content version
1432
+ responses:
1433
+ '200':
1434
+ description: Success
1435
+ body:
1436
+ application/json:
1437
+ type: ManagedContentVersionV2Representation
1438
+ body:
1439
+ application/json:
1440
+ type: ManagedContentVersionV2InputRepresentation
1441
+ (oas-body-name): managedContentVersionV2Request
1442
+ uriParameters:
1443
+ managedContentVersionId:
1444
+ type: string
1445
+ required: true
1446
+ /versions:
1447
+ post:
1448
+ description: Create Managed Content Versions for Json store
1449
+ responses:
1450
+ '200':
1451
+ description: Success
1452
+ body:
1453
+ application/json:
1454
+ type: ManagedContentVersionV2CollectionRepresentation
1455
+ body:
1456
+ application/json:
1457
+ type: ManagedContentVersionV2CollectionInputRepresentation
1458
+ (oas-body-name): managedContentVersionV2CollectionRequest
1459
+ /delivery:
1460
+ /channels/{channelId}:
1461
+ /collections/{collectionKeyOrId}:
1462
+ get:
1463
+ description: Get collection Items.
1464
+ responses:
1465
+ '200':
1466
+ description: Success
1467
+ body:
1468
+ application/json:
1469
+ type: ManagedContentCollectionItemsRepresentation
1470
+ queryParameters:
1471
+ language:
1472
+ type: string
1473
+ required: false
1474
+ uriParameters:
1475
+ channelId:
1476
+ type: string
1477
+ required: true
1478
+ collectionKeyOrId:
1479
+ type: string
1480
+ required: true
1481
+ /collections/{collectionKeyOrId}/metadata:
1482
+ get:
1483
+ description: Get collection metadata.
1484
+ responses:
1485
+ '200':
1486
+ description: Success
1487
+ body:
1488
+ application/json:
1489
+ type: ManagedContentCollectionMetadataRepresentation
1490
+ queryParameters:
1491
+ expandMetadata:
1492
+ type: boolean
1493
+ required: false
1494
+ language:
1495
+ type: string
1496
+ required: false
1497
+ uriParameters:
1498
+ channelId:
1499
+ type: string
1500
+ required: true
1501
+ collectionKeyOrId:
1502
+ type: string
1503
+ required: true
1504
+ /contents:
1505
+ /query:
1506
+ get:
1507
+ description: Get list of managed content versions.
1508
+ responses:
1509
+ '200':
1510
+ description: Success
1511
+ body:
1512
+ application/json:
1513
+ type: ManagedContentVersionCollectionRepresentation
1514
+ queryParameters:
1515
+ contentKeys:
1516
+ type: array
1517
+ required: false
1518
+ items:
1519
+ type: string
1520
+ (oas-collectionFormat): csv
1521
+ endDate:
1522
+ type: string
1523
+ required: false
1524
+ includeMetadata:
1525
+ type: boolean
1526
+ required: false
1527
+ language:
1528
+ type: string
1529
+ required: false
1530
+ managedContentIds:
1531
+ type: array
1532
+ required: false
1533
+ items:
1534
+ type: string
1535
+ (oas-collectionFormat): csv
1536
+ managedContentType:
1537
+ type: string
1538
+ required: false
1539
+ page:
1540
+ type: integer
1541
+ required: false
1542
+ pageSize:
1543
+ type: integer
1544
+ required: false
1545
+ showAbsoluteUrl:
1546
+ type: boolean
1547
+ required: false
1548
+ startDate:
1549
+ type: string
1550
+ required: false
1551
+ uriParameters:
1552
+ channelId:
1553
+ type: string
1554
+ required: true
1555
+ /search:
1556
+ get:
1557
+ description: Get the contents related to search terms
1558
+ responses:
1559
+ '200':
1560
+ description: Success
1561
+ body:
1562
+ application/json:
1563
+ type: ManagedContentSearchResultCollectionRepresentation
1564
+ queryParameters:
1565
+ page:
1566
+ type: integer
1567
+ required: false
1568
+ pageSize:
1569
+ type: integer
1570
+ required: false
1571
+ queryTerm:
1572
+ type: string
1573
+ required: false
1574
+ scope:
1575
+ type: string
1576
+ required: false
1577
+ enum:
1578
+ - All
1579
+ - TitleOnly
1580
+ uriParameters:
1581
+ channelId:
1582
+ type: string
1583
+ required: true
1584
+ /media/{mediaGuid}/content:
1585
+ get:
1586
+ description: Returns a binary stream of the contents of the specified
1587
+ media.
1588
+ responses:
1589
+ '200':
1590
+ description: Success
1591
+ body:
1592
+ application/json:
1593
+ type: StreamedRepresentation
1594
+ uriParameters:
1595
+ channelId:
1596
+ type: string
1597
+ required: true
1598
+ mediaGuid:
1599
+ type: string
1600
+ required: true
1601
+ /records/{recordId}/contents:
1602
+ get:
1603
+ description: Get list of managed content versions for the given record Id.
1604
+ responses:
1605
+ '200':
1606
+ description: Success
1607
+ body:
1608
+ application/json:
1609
+ type: ManagedContentVersionCollectionRepresentation
1610
+ queryParameters:
1611
+ includeMetadata:
1612
+ type: boolean
1613
+ required: false
1614
+ language:
1615
+ type: string
1616
+ required: false
1617
+ managedContentIds:
1618
+ type: array
1619
+ required: false
1620
+ items:
1621
+ type: string
1622
+ (oas-collectionFormat): csv
1623
+ page:
1624
+ type: integer
1625
+ required: false
1626
+ pageSize:
1627
+ type: integer
1628
+ required: false
1629
+ uriParameters:
1630
+ recordId:
1631
+ type: string
1632
+ required: true
1633
+ /folders/{folderId}:
1634
+ get:
1635
+ description: Get information of a folder
1636
+ responses:
1637
+ '200':
1638
+ description: Success
1639
+ body:
1640
+ application/json:
1641
+ type: ManagedContentSpaceFolderDetailRepresentation
1642
+ uriParameters:
1643
+ folderId:
1644
+ type: string
1645
+ required: true
1646
+ /folders/{folderId}/items:
1647
+ get:
1648
+ description: Get list of folder items
1649
+ responses:
1650
+ '200':
1651
+ description: Success
1652
+ body:
1653
+ application/json:
1654
+ type: ManagedContentSpaceFolderItemCollectionRepresentation
1655
+ queryParameters:
1656
+ filter:
1657
+ type: string
1658
+ required: false
1659
+ enum:
1660
+ - Content
1661
+ - Folders
1662
+ managedContentType:
1663
+ type: string
1664
+ required: false
1665
+ page:
1666
+ type: integer
1667
+ required: false
1668
+ pageSize:
1669
+ type: integer
1670
+ required: false
1671
+ queryTerm:
1672
+ type: string
1673
+ required: false
1674
+ showPublishedOnly:
1675
+ type: boolean
1676
+ required: false
1677
+ sortBy:
1678
+ type: string
1679
+ required: false
1680
+ enum:
1681
+ - LastModified
1682
+ - Status
1683
+ - Title
1684
+ sortOrder:
1685
+ type: string
1686
+ required: false
1687
+ patch:
1688
+ description: Patch specified folder item IDs - Supporting move operation only
1689
+ responses:
1690
+ '200':
1691
+ description: Success
1692
+ body:
1693
+ application/json:
1694
+ type: ManagedContentSpaceFolderItemCollectionRepresentation
1695
+ body:
1696
+ application/json:
1697
+ type: ManagedContentSpaceFolderItemCollectionInputRep
1698
+ (oas-body-name): folderItemsPatchInput
1699
+ uriParameters:
1700
+ folderId:
1701
+ type: string
1702
+ required: true
1703
+ /spaces/{contentSpaceId}:
1704
+ get:
1705
+ description: Get a specific ManagedContentSpace record
1706
+ responses:
1707
+ '200':
1708
+ description: Success
1709
+ body:
1710
+ application/json:
1711
+ type: ManagedContentSpaceRepresentation
1712
+ uriParameters:
1713
+ contentSpaceId:
1714
+ type: string
1715
+ required: true
1716
+ /communities/{communityId}/managed-content/delivery:
1717
+ get:
1718
+ description: Get list of managed content versions.
1719
+ responses:
1720
+ '200':
1721
+ description: Success
1722
+ body:
1723
+ application/json:
1724
+ type: ManagedContentVersionCollectionRepresentation
1725
+ queryParameters:
1726
+ contentKeys:
1727
+ type: array
1728
+ required: false
1729
+ items:
1730
+ type: string
1731
+ (oas-collectionFormat): csv
1732
+ language:
1733
+ type: string
1734
+ required: false
1735
+ managedContentIds:
1736
+ type: array
1737
+ required: false
1738
+ items:
1739
+ type: string
1740
+ (oas-collectionFormat): csv
1741
+ managedContentType:
1742
+ type: string
1743
+ required: false
1744
+ page:
1745
+ type: integer
1746
+ required: false
1747
+ pageSize:
1748
+ type: integer
1749
+ required: false
1750
+ showAbsoluteUrl:
1751
+ type: boolean
1752
+ required: false
1753
+ topics:
1754
+ type: array
1755
+ required: false
1756
+ items:
1757
+ type: string
1758
+ (oas-collectionFormat): csv
1759
+ uriParameters:
1760
+ communityId:
1761
+ type: string
1762
+ required: true
1763
+ /communities/{communityId}/managed-content/delivery/contents:
1764
+ get:
1765
+ description: Get list of managed content versions.
1766
+ responses:
1767
+ '200':
1768
+ description: Success
1769
+ body:
1770
+ application/json:
1771
+ type: ManagedContentVersionInternalCollectionRepresentation
1772
+ queryParameters:
1773
+ collectionName:
1774
+ type: string
1775
+ required: false
1776
+ contentKeys:
1777
+ type: array
1778
+ required: false
1779
+ items:
1780
+ type: string
1781
+ (oas-collectionFormat): csv
1782
+ language:
1783
+ type: string
1784
+ required: false
1785
+ managedContentIds:
1786
+ type: array
1787
+ required: false
1788
+ items:
1789
+ type: string
1790
+ (oas-collectionFormat): csv
1791
+ managedContentType:
1792
+ type: string
1793
+ required: false
1794
+ page:
1795
+ type: integer
1796
+ required: false
1797
+ pageSize:
1798
+ type: integer
1799
+ required: false
1800
+ queryTerm:
1801
+ type: string
1802
+ required: false
1803
+ topics:
1804
+ type: array
1805
+ required: false
1806
+ items:
1807
+ type: string
1808
+ (oas-collectionFormat): csv
1809
+ urlNameInList:
1810
+ type: array
1811
+ required: false
1812
+ items:
1813
+ type: string
1814
+ (oas-collectionFormat): csv
1815
+ uriParameters:
1816
+ communityId:
1817
+ type: string
1818
+ required: true
1819
+ /search:
1820
+ get:
1821
+ description: Get the contents related to search terms
1822
+ responses:
1823
+ '200':
1824
+ description: Success
1825
+ body:
1826
+ application/json:
1827
+ type: ManagedContentSearchResultCollectionRepresentation
1828
+ queryParameters:
1829
+ page:
1830
+ type: integer
1831
+ required: false
1832
+ pageSize:
1833
+ type: integer
1834
+ required: false
1835
+ queryTerm:
1836
+ type: string
1837
+ required: false
1838
+ scope:
1839
+ type: string
1840
+ required: false
1841
+ enum:
1842
+ - All
1843
+ - TitleOnly
1844
+ uriParameters:
1845
+ communityId:
1846
+ type: string
1847
+ required: true
1848
+ /{managedContentId}:
1849
+ get:
1850
+ description: Get the published version of the managed content.
1851
+ responses:
1852
+ '200':
1853
+ description: Success
1854
+ body:
1855
+ application/json:
1856
+ type: ManagedContentVersionInternalRepresentation
1857
+ uriParameters:
1858
+ communityId:
1859
+ type: string
1860
+ required: true
1861
+ managedContentId:
1862
+ type: string
1863
+ required: true
1864
+ /managed-content:
1865
+ /content-spaces/{contentSpaceId}:
1866
+ /content-versions:
1867
+ post:
1868
+ description: Create a manage content version
1869
+ responses:
1870
+ '200':
1871
+ description: Success
1872
+ body:
1873
+ application/json:
1874
+ type: ManagedContentVersionInternalRepresentation
1875
+ body:
1876
+ application/json:
1877
+ type: ManagedContentVersionInputRep
1878
+ (oas-body-name): contentVersion
1879
+ uriParameters:
1880
+ contentSpaceId:
1881
+ type: string
1882
+ required: true
1883
+ /content-versions/{managedContentVersionId}:
1884
+ get:
1885
+ description: Get a single managed content version
1886
+ responses:
1887
+ '200':
1888
+ description: Success
1889
+ body:
1890
+ application/json:
1891
+ type: ManagedContentVersionInternalRepresentation
1892
+ queryParameters:
1893
+ language:
1894
+ type: string
1895
+ required: false
1896
+ patch:
1897
+ description: Update a managed content version
1898
+ responses:
1899
+ '200':
1900
+ description: Success
1901
+ body:
1902
+ application/json:
1903
+ type: ManagedContentVersionInternalRepresentation
1904
+ body:
1905
+ application/json:
1906
+ type: ManagedContentVersionInputRep
1907
+ (oas-body-name): contentVersion
1908
+ uriParameters:
1909
+ contentSpaceId:
1910
+ type: string
1911
+ required: true
1912
+ managedContentVersionId:
1913
+ type: string
1914
+ required: true
1915
+ /contents/{managedContentId}:
1916
+ delete:
1917
+ description: Delete a nonpublished managed content given its Id
1918
+ responses:
1919
+ '200':
1920
+ description: Success
1921
+ patch:
1922
+ description: Update a managed content
1923
+ responses:
1924
+ '200':
1925
+ description: Success
1926
+ body:
1927
+ application/json:
1928
+ type: ManagedContentRepresentation
1929
+ body:
1930
+ application/json:
1931
+ type: ManagedContentInputRep
1932
+ (oas-body-name): contentVersion
1933
+ uriParameters:
1934
+ contentSpaceId:
1935
+ type: string
1936
+ required: true
1937
+ managedContentId:
1938
+ type: string
1939
+ required: true
1940
+ /members:
1941
+ get:
1942
+ description: Get the members of a content space
1943
+ responses:
1944
+ '200':
1945
+ description: Success
1946
+ body:
1947
+ application/json:
1948
+ type: ManagedContentSpaceMemberCollectionRepresentation
1949
+ post:
1950
+ description: Add a member with a role to a content space
1951
+ responses:
1952
+ '200':
1953
+ description: Success
1954
+ body:
1955
+ application/json:
1956
+ type: ManagedContentSpaceMemberRepresentation
1957
+ body:
1958
+ application/json:
1959
+ type: ManagedContentSpaceMemberInputRepresentation
1960
+ (oas-body-name): member
1961
+ uriParameters:
1962
+ contentSpaceId:
1963
+ type: string
1964
+ required: true
1965
+ /members/{memberIdOrMe}:
1966
+ delete:
1967
+ description: Delete the membership in a content space for a member
1968
+ responses:
1969
+ '200':
1970
+ description: Success
1971
+ patch:
1972
+ description: Update the membership in a content space for a member with
1973
+ a new role
1974
+ responses:
1975
+ '200':
1976
+ description: Success
1977
+ body:
1978
+ application/json:
1979
+ type: ManagedContentSpaceMemberRepresentation
1980
+ body:
1981
+ application/json:
1982
+ type: ManagedContentSpaceMemberInputRepresentation
1983
+ (oas-body-name): member
1984
+ uriParameters:
1985
+ contentSpaceId:
1986
+ type: string
1987
+ required: true
1988
+ memberIdOrMe:
1989
+ type: string
1990
+ required: true
1991
+ /members/{memberIdOrMe}/permissions:
1992
+ get:
1993
+ description: Get the permissions for a member in a content space
1994
+ responses:
1995
+ '200':
1996
+ description: Success
1997
+ body:
1998
+ application/json:
1999
+ type: ManagedContentSpaceMemberPermissionsRepresentation
2000
+ uriParameters:
2001
+ contentSpaceId:
2002
+ type: string
2003
+ required: true
2004
+ memberIdOrMe:
2005
+ type: string
2006
+ required: true
2007
+ /delivery/contents/{managedContentId}:
2008
+ get:
2009
+ description: Get the published version of the managed content.
2010
+ responses:
2011
+ '200':
2012
+ description: Success
2013
+ body:
2014
+ application/json:
2015
+ type: ManagedContentVersionInternalRepresentation
2016
+ uriParameters:
2017
+ managedContentId:
2018
+ type: string
2019
+ required: true
2020
+ /roles:
2021
+ get:
2022
+ description: Get the roles available in a content space
2023
+ responses:
2024
+ '200':
2025
+ description: Success
2026
+ body:
2027
+ application/json:
2028
+ type: ManagedContentSpaceRoleCollectionRepresentation
2029
+ queryParameters:
2030
+ roleQueryScope:
2031
+ type: string
2032
+ required: false
2033
+ enum:
2034
+ - AuthoringRole
2035
+ - SiteRole
2036
+ /translation:
2037
+ post:
2038
+ description: Create a translation job
2039
+ responses:
2040
+ '200':
2041
+ description: Success
2042
+ body:
2043
+ application/json:
2044
+ type: ManagedContentTranslationRepresentation
2045
+ body:
2046
+ application/json:
2047
+ type: ManagedContentTranslationRequestInputRep
2048
+ (oas-body-name): translationRequest
2049
+ /sites/{siteId}/cms/delivery/collections/{collectionKeyOrId}:
2050
+ get:
2051
+ description: Get collection Items.
2052
+ responses:
2053
+ '200':
2054
+ description: Success
2055
+ body:
2056
+ application/json:
2057
+ type: ManagedContentCollectionItemsRepresentation
2058
+ queryParameters:
2059
+ language:
2060
+ type: string
2061
+ required: false
2062
+ uriParameters:
2063
+ collectionKeyOrId:
2064
+ type: string
2065
+ required: true
2066
+ siteId:
2067
+ type: string
2068
+ required: true
2069
+ /sites/{siteId}/cms/delivery/collections/{collectionKeyOrId}/metadata:
2070
+ get:
2071
+ description: Get collection metadata.
2072
+ responses:
2073
+ '200':
2074
+ description: Success
2075
+ body:
2076
+ application/json:
2077
+ type: ManagedContentCollectionMetadataRepresentation
2078
+ queryParameters:
2079
+ expandMetadata:
2080
+ type: boolean
2081
+ required: false
2082
+ language:
2083
+ type: string
2084
+ required: false
2085
+ uriParameters:
2086
+ collectionKeyOrId:
2087
+ type: string
2088
+ required: true
2089
+ siteId:
2090
+ type: string
2091
+ required: true