@salesforce/lds-adapters-cms-authoring 1.100.1

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 (251) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/cms-authoring.js +6660 -0
  3. package/dist/types/src/generated/adapters/adapter-utils.d.ts +66 -0
  4. package/dist/types/src/generated/adapters/createDeployment.d.ts +15 -0
  5. package/dist/types/src/generated/adapters/createManagedContent.d.ts +15 -0
  6. package/dist/types/src/generated/adapters/createManagedContentExportV2Job.d.ts +16 -0
  7. package/dist/types/src/generated/adapters/createManagedContentImportV2Job.d.ts +16 -0
  8. package/dist/types/src/generated/adapters/createManagedContentVariant.d.ts +15 -0
  9. package/dist/types/src/generated/adapters/createTranslationV2Job.d.ts +16 -0
  10. package/dist/types/src/generated/adapters/deleteManagedContentVariant.d.ts +13 -0
  11. package/dist/types/src/generated/adapters/getCollectionItems.d.ts +28 -0
  12. package/dist/types/src/generated/adapters/getManagedContent.d.ts +28 -0
  13. package/dist/types/src/generated/adapters/getManagedContentByFolderId.d.ts +36 -0
  14. package/dist/types/src/generated/adapters/getManagedContentReferencedBy.d.ts +30 -0
  15. package/dist/types/src/generated/adapters/getManagedContentSpaces.d.ts +27 -0
  16. package/dist/types/src/generated/adapters/getManagedContentVariant.d.ts +27 -0
  17. package/dist/types/src/generated/adapters/getManagedContentVariantReferences.d.ts +27 -0
  18. package/dist/types/src/generated/adapters/getManagedContentVariantRendition.d.ts +30 -0
  19. package/dist/types/src/generated/adapters/getManagedContentVariantVersions.d.ts +30 -0
  20. package/dist/types/src/generated/adapters/getSearchResults.d.ts +32 -0
  21. package/dist/types/src/generated/adapters/publishManagedContent.d.ts +15 -0
  22. package/dist/types/src/generated/adapters/replaceManagedContentVariant.d.ts +16 -0
  23. package/dist/types/src/generated/adapters/unpublishManagedContent.d.ts +15 -0
  24. package/dist/types/src/generated/artifacts/main.d.ts +20 -0
  25. package/dist/types/src/generated/artifacts/sfdc.d.ts +33 -0
  26. package/dist/types/src/generated/resources/deleteCmsDeploymentsByDeploymentId.d.ts +9 -0
  27. package/dist/types/src/generated/resources/deleteCmsSiteAuthorContentByContentKey.d.ts +14 -0
  28. package/dist/types/src/generated/resources/deleteConnectCmsContentJobsByJobId.d.ts +11 -0
  29. package/dist/types/src/generated/resources/deleteConnectCmsContentsVariantsByVariantId.d.ts +12 -0
  30. package/dist/types/src/generated/resources/deleteConnectManagedContentContentSpacesContentsByContentSpaceIdAndManagedContentId.d.ts +10 -0
  31. package/dist/types/src/generated/resources/deleteConnectManagedContentContentSpacesMembersByContentSpaceIdAndMemberIdOrMe.d.ts +10 -0
  32. package/dist/types/src/generated/resources/getCmsDeliveryCollectionByCollectionNameOrContentKeyAndTargetId.d.ts +21 -0
  33. package/dist/types/src/generated/resources/getCmsDeliveryCollectionMetadataByCollectionNameOrContentKeyAndTargetId.d.ts +19 -0
  34. package/dist/types/src/generated/resources/getCmsDeployments.d.ts +21 -0
  35. package/dist/types/src/generated/resources/getCmsSiteAuthorContentByContentKey.d.ts +18 -0
  36. package/dist/types/src/generated/resources/getCmsSiteAuthorContentContentKeys.d.ts +17 -0
  37. package/dist/types/src/generated/resources/getCmsSiteAuthorContentNodeByContentKeyAndContentNode.d.ts +16 -0
  38. package/dist/types/src/generated/resources/getCmsSiteAuthorContentNodesByContentKey.d.ts +18 -0
  39. package/dist/types/src/generated/resources/getCmsSpacesPreviewEndpointsByContentSpaceId.d.ts +18 -0
  40. package/dist/types/src/generated/resources/getConnectCmsChannelsSearchableContentTypesByChannelId.d.ts +19 -0
  41. package/dist/types/src/generated/resources/getConnectCmsCollectionsByCollectionKeyOrId.d.ts +19 -0
  42. package/dist/types/src/generated/resources/getConnectCmsContent.d.ts +16 -0
  43. package/dist/types/src/generated/resources/getConnectCmsContentJobsByJobId.d.ts +15 -0
  44. package/dist/types/src/generated/resources/getConnectCmsContentTypesByContentTypeFQN.d.ts +19 -0
  45. package/dist/types/src/generated/resources/getConnectCmsContentVersionByManagedContentVersionId.d.ts +19 -0
  46. package/dist/types/src/generated/resources/getConnectCmsContentsByContentKeyOrId.d.ts +19 -0
  47. package/dist/types/src/generated/resources/getConnectCmsContentsReferencedByByContentKeyOrId.d.ts +21 -0
  48. package/dist/types/src/generated/resources/getConnectCmsContentsRenditionsByContentKeyOrIdAndRenditionType.d.ts +21 -0
  49. package/dist/types/src/generated/resources/getConnectCmsContentsVariantsByVariantId.d.ts +16 -0
  50. package/dist/types/src/generated/resources/getConnectCmsContentsVariantsReferencesByContentKeyOrId.d.ts +18 -0
  51. package/dist/types/src/generated/resources/getConnectCmsContentsVariantsVersionsByVariantId.d.ts +21 -0
  52. package/dist/types/src/generated/resources/getConnectCmsDeliveriesContentsByContentKeyOrIdAndDeliveryChannelIdOrSiteId.d.ts +19 -0
  53. package/dist/types/src/generated/resources/getConnectCmsFoldersByFolderId.d.ts +15 -0
  54. package/dist/types/src/generated/resources/getConnectCmsFoldersItemsByFolderId.d.ts +27 -0
  55. package/dist/types/src/generated/resources/getConnectCmsItemsSearch.d.ts +21 -0
  56. package/dist/types/src/generated/resources/getConnectCmsSpaces.d.ts +16 -0
  57. package/dist/types/src/generated/resources/getConnectCmsSpacesByContentSpaceId.d.ts +15 -0
  58. package/dist/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryByCommunityId.d.ts +25 -0
  59. package/dist/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryContentsByCommunityId.d.ts +27 -0
  60. package/dist/types/src/generated/resources/getConnectCommunitiesManagedContentDeliveryContentsSearchByCommunityId.d.ts +21 -0
  61. package/dist/types/src/generated/resources/getConnectManagedContentContentSpacesContentVersionsByContentSpaceIdAndManagedContentVersionId.d.ts +19 -0
  62. package/dist/types/src/generated/resources/getConnectManagedContentContentSpacesMembersByContentSpaceId.d.ts +15 -0
  63. package/dist/types/src/generated/resources/getConnectManagedContentContentSpacesMembersPermissionsByContentSpaceIdAndMemberIdOrMe.d.ts +16 -0
  64. package/dist/types/src/generated/resources/getConnectManagedContentRoles.d.ts +15 -0
  65. package/dist/types/src/generated/resources/patchCmsDeploymentsByDeploymentId.d.ts +12 -0
  66. package/dist/types/src/generated/resources/patchConnectCmsChannelsSearchableContentTypesByChannelId.d.ts +13 -0
  67. package/dist/types/src/generated/resources/patchConnectCmsContentVersionByManagedContentVersionId.d.ts +21 -0
  68. package/dist/types/src/generated/resources/patchConnectCmsFoldersItemsByFolderId.d.ts +13 -0
  69. package/dist/types/src/generated/resources/patchConnectCmsSchedulesByDeploymentId.d.ts +16 -0
  70. package/dist/types/src/generated/resources/patchConnectCmsSpacesByContentSpaceId.d.ts +19 -0
  71. package/dist/types/src/generated/resources/patchConnectManagedContentContentSpacesContentVersionsByContentSpaceIdAndManagedContentVersionId.d.ts +21 -0
  72. package/dist/types/src/generated/resources/patchConnectManagedContentContentSpacesContentsByContentSpaceIdAndManagedContentId.d.ts +14 -0
  73. package/dist/types/src/generated/resources/patchConnectManagedContentContentSpacesMembersByContentSpaceIdAndMemberIdOrMe.d.ts +14 -0
  74. package/dist/types/src/generated/resources/postCmsDeliveryChannelsVariantsByChannelId.d.ts +16 -0
  75. package/dist/types/src/generated/resources/postCmsDeployments.d.ts +13 -0
  76. package/dist/types/src/generated/resources/postCmsSiteDeliveryContentsContentKeysByChannelId.d.ts +16 -0
  77. package/dist/types/src/generated/resources/postCmsSiteDeliveryContentsContentTypesByChannelId.d.ts +15 -0
  78. package/dist/types/src/generated/resources/postCmsSiteDeliveryContentsNodeIdsByChannelId.d.ts +16 -0
  79. package/dist/types/src/generated/resources/postConnectCmsContentJobsExport.d.ts +17 -0
  80. package/dist/types/src/generated/resources/postConnectCmsContentJobsImport.d.ts +16 -0
  81. package/dist/types/src/generated/resources/postConnectCmsContentSpacesTranslationByContentSpaceId.d.ts +16 -0
  82. package/dist/types/src/generated/resources/postConnectCmsContentSpacesVersionByContentSpaceId.d.ts +24 -0
  83. package/dist/types/src/generated/resources/postConnectCmsContentSpacesVersionsByContentSpaceId.d.ts +15 -0
  84. package/dist/types/src/generated/resources/postConnectCmsContentVariant.d.ts +18 -0
  85. package/dist/types/src/generated/resources/postConnectCmsContents.d.ts +13 -0
  86. package/dist/types/src/generated/resources/postConnectCmsContentsPublish.d.ts +13 -0
  87. package/dist/types/src/generated/resources/postConnectCmsContentsUnpublish.d.ts +13 -0
  88. package/dist/types/src/generated/resources/postConnectCmsContentsVariants.d.ts +13 -0
  89. package/dist/types/src/generated/resources/postConnectCmsFolders.d.ts +13 -0
  90. package/dist/types/src/generated/resources/postConnectCmsSchedules.d.ts +18 -0
  91. package/dist/types/src/generated/resources/postConnectCmsSpaces.d.ts +19 -0
  92. package/dist/types/src/generated/resources/postConnectCmsSpacesContentsExportByContentSpaceId.d.ts +16 -0
  93. package/dist/types/src/generated/resources/postConnectCmsSpacesContentsImportByContentSpaceId.d.ts +16 -0
  94. package/dist/types/src/generated/resources/postConnectManagedContentContentSpacesContentVersionsByContentSpaceId.d.ts +23 -0
  95. package/dist/types/src/generated/resources/postConnectManagedContentContentSpacesMembersByContentSpaceId.d.ts +16 -0
  96. package/dist/types/src/generated/resources/postConnectManagedContentTranslation.d.ts +15 -0
  97. package/dist/types/src/generated/resources/putConnectCmsContentVersionByManagedContentVersionId.d.ts +21 -0
  98. package/dist/types/src/generated/resources/putConnectCmsContentsVariantsByVariantId.d.ts +16 -0
  99. package/dist/types/src/generated/types/AbstractMCSFolderRepresentation.d.ts +38 -0
  100. package/dist/types/src/generated/types/AbstractMContentRepresentation.d.ts +53 -0
  101. package/dist/types/src/generated/types/AbstractManagedContentReferencedByContributorRepresentation.d.ts +44 -0
  102. package/dist/types/src/generated/types/AbstractManagedContentReferencedByItemRepresentation.d.ts +50 -0
  103. package/dist/types/src/generated/types/AbstractManagedContentSearchResultRepresentation.d.ts +49 -0
  104. package/dist/types/src/generated/types/CMSChannelRepresentation.d.ts +47 -0
  105. package/dist/types/src/generated/types/MCDeliveryV2VariantCollectionRepresentation.d.ts +30 -0
  106. package/dist/types/src/generated/types/MCDeliveryV2VariantInputRepresentation.d.ts +32 -0
  107. package/dist/types/src/generated/types/MCDeliveryV2VariantRepresentation.d.ts +53 -0
  108. package/dist/types/src/generated/types/MCSiteContentCollectionRepresentation.d.ts +30 -0
  109. package/dist/types/src/generated/types/MCSiteContentRepresentation.d.ts +46 -0
  110. package/dist/types/src/generated/types/MCSiteDeliveryByContentKeysInputRepresentation.d.ts +32 -0
  111. package/dist/types/src/generated/types/MCSiteDeliveryByContentTypesInputRepresentation.d.ts +29 -0
  112. package/dist/types/src/generated/types/MCSiteDeliveryByNodesInputRepresentation.d.ts +32 -0
  113. package/dist/types/src/generated/types/MCSiteNodeCollectionRepresentation.d.ts +30 -0
  114. package/dist/types/src/generated/types/MCSiteNodeRepresentation.d.ts +45 -0
  115. package/dist/types/src/generated/types/MCSiteVariantRepresentation.d.ts +47 -0
  116. package/dist/types/src/generated/types/MContentBodyRepresentation.d.ts +33 -0
  117. package/dist/types/src/generated/types/MContentCollectionMetadataRepresentation.d.ts +39 -0
  118. package/dist/types/src/generated/types/MContentCollectionRepresentation.d.ts +51 -0
  119. package/dist/types/src/generated/types/MContentDetailRepresentation.d.ts +31 -0
  120. package/dist/types/src/generated/types/MContentSummaryRepresentation.d.ts +27 -0
  121. package/dist/types/src/generated/types/ManagedContentAssociationsInputRep.d.ts +33 -0
  122. package/dist/types/src/generated/types/ManagedContentAssociationsRepresentation.d.ts +30 -0
  123. package/dist/types/src/generated/types/ManagedContentBodyInputRep.d.ts +33 -0
  124. package/dist/types/src/generated/types/ManagedContentChannelSummaryRepresentation.d.ts +35 -0
  125. package/dist/types/src/generated/types/ManagedContentChannelTargetEntitySummaryRepresentation.d.ts +29 -0
  126. package/dist/types/src/generated/types/ManagedContentChildRepresentation.d.ts +35 -0
  127. package/dist/types/src/generated/types/ManagedContentCollectionDetailRepresentation.d.ts +73 -0
  128. package/dist/types/src/generated/types/ManagedContentCollectionItemRepresentation.d.ts +42 -0
  129. package/dist/types/src/generated/types/ManagedContentCollectionItemTypeSummaryRepresentation.d.ts +32 -0
  130. package/dist/types/src/generated/types/ManagedContentCollectionRepresentation.d.ts +30 -0
  131. package/dist/types/src/generated/types/ManagedContentDateAndTimeNodeValueRepresentation.d.ts +33 -0
  132. package/dist/types/src/generated/types/ManagedContentDateNodeValueRepresentation.d.ts +30 -0
  133. package/dist/types/src/generated/types/ManagedContentDeploymentCollectionRepresentation.d.ts +48 -0
  134. package/dist/types/src/generated/types/ManagedContentDeploymentInputRepresentation.d.ts +50 -0
  135. package/dist/types/src/generated/types/ManagedContentDeploymentInputWrapperRepresentation.d.ts +29 -0
  136. package/dist/types/src/generated/types/ManagedContentDeploymentItemRepresentation.d.ts +41 -0
  137. package/dist/types/src/generated/types/ManagedContentDeploymentRepresentation.d.ts +61 -0
  138. package/dist/types/src/generated/types/ManagedContentDetailCollectionRepresentation.d.ts +33 -0
  139. package/dist/types/src/generated/types/ManagedContentDetailRepresentation.d.ts +38 -0
  140. package/dist/types/src/generated/types/ManagedContentDocumentDeliveryRepresentation.d.ts +58 -0
  141. package/dist/types/src/generated/types/ManagedContentDocumentRepresentation.d.ts +103 -0
  142. package/dist/types/src/generated/types/ManagedContentExportContentJobRequestInputRepresentation.d.ts +44 -0
  143. package/dist/types/src/generated/types/ManagedContentExportContentV2JobRequestInputRepresentation.d.ts +41 -0
  144. package/dist/types/src/generated/types/ManagedContentExportContentV2JobRequestInputWrapperRep.d.ts +29 -0
  145. package/dist/types/src/generated/types/ManagedContentExportJobItemIdsInputList.d.ts +29 -0
  146. package/dist/types/src/generated/types/ManagedContentFolderSearchResultRepresentation.d.ts +30 -0
  147. package/dist/types/src/generated/types/ManagedContentFolderSummaryRepresentation.d.ts +32 -0
  148. package/dist/types/src/generated/types/ManagedContentImportV2JobRequestInputWrapperRep.d.ts +29 -0
  149. package/dist/types/src/generated/types/ManagedContentInputRep.d.ts +32 -0
  150. package/dist/types/src/generated/types/ManagedContentInputRepresentation.d.ts +45 -0
  151. package/dist/types/src/generated/types/ManagedContentInputWrapperRepresentation.d.ts +29 -0
  152. package/dist/types/src/generated/types/ManagedContentJobRepresentation.d.ts +65 -0
  153. package/dist/types/src/generated/types/ManagedContentJobRequestInputRepresentation.d.ts +41 -0
  154. package/dist/types/src/generated/types/ManagedContentLanguageSummaryRepresentation.d.ts +32 -0
  155. package/dist/types/src/generated/types/ManagedContentMediaNodeValueRepresentation.d.ts +57 -0
  156. package/dist/types/src/generated/types/ManagedContentMediaSourceNodeValueRepresentation.d.ts +51 -0
  157. package/dist/types/src/generated/types/ManagedContentNodeTypeRepresentation.d.ts +35 -0
  158. package/dist/types/src/generated/types/ManagedContentNodeValueRepresentation.d.ts +29 -0
  159. package/dist/types/src/generated/types/ManagedContentPreviewCollectionRepresentation.d.ts +30 -0
  160. package/dist/types/src/generated/types/ManagedContentPreviewRepresentation.d.ts +32 -0
  161. package/dist/types/src/generated/types/ManagedContentPublishInputRepresentation.d.ts +38 -0
  162. package/dist/types/src/generated/types/ManagedContentPublishInputWrapperRepresentation.d.ts +29 -0
  163. package/dist/types/src/generated/types/ManagedContentPublishOutputRepresentation.d.ts +45 -0
  164. package/dist/types/src/generated/types/ManagedContentReferencedByCollectionRepresentation.d.ts +40 -0
  165. package/dist/types/src/generated/types/ManagedContentReferencedByContributorItemRepresentation.d.ts +38 -0
  166. package/dist/types/src/generated/types/ManagedContentReferencedByContributorRepresentation.d.ts +36 -0
  167. package/dist/types/src/generated/types/ManagedContentReferencedByContributorWithContributorItemsRepresentation.d.ts +31 -0
  168. package/dist/types/src/generated/types/ManagedContentReferencedByItemRepresentation.d.ts +27 -0
  169. package/dist/types/src/generated/types/ManagedContentReferencedByRecordRepresentation.d.ts +33 -0
  170. package/dist/types/src/generated/types/ManagedContentReferencedByVariantRepresentation.d.ts +31 -0
  171. package/dist/types/src/generated/types/ManagedContentRenditionRepresentation.d.ts +50 -0
  172. package/dist/types/src/generated/types/ManagedContentRepresentation.d.ts +32 -0
  173. package/dist/types/src/generated/types/ManagedContentScheduleInputRepresentation.d.ts +47 -0
  174. package/dist/types/src/generated/types/ManagedContentSearchResultCollectionRepresentation.d.ts +39 -0
  175. package/dist/types/src/generated/types/ManagedContentSearchResultContentTypeRepresentation.d.ts +32 -0
  176. package/dist/types/src/generated/types/ManagedContentSearchResultItemsCollectionRepresentation.d.ts +40 -0
  177. package/dist/types/src/generated/types/ManagedContentSearchResultRepresentation.d.ts +45 -0
  178. package/dist/types/src/generated/types/ManagedContentSpaceCollectionRepresentation.d.ts +31 -0
  179. package/dist/types/src/generated/types/ManagedContentSpaceFolderDetailRepresentation.d.ts +43 -0
  180. package/dist/types/src/generated/types/ManagedContentSpaceFolderInputRep.d.ts +32 -0
  181. package/dist/types/src/generated/types/ManagedContentSpaceFolderItemCollectionInputRep.d.ts +32 -0
  182. package/dist/types/src/generated/types/ManagedContentSpaceFolderItemCollectionRepresentation.d.ts +37 -0
  183. package/dist/types/src/generated/types/ManagedContentSpaceFolderItemRepresentation.d.ts +75 -0
  184. package/dist/types/src/generated/types/ManagedContentSpaceFolderRepresentation.d.ts +27 -0
  185. package/dist/types/src/generated/types/ManagedContentSpaceInputRepresentation.d.ts +50 -0
  186. package/dist/types/src/generated/types/ManagedContentSpaceMemberCollectionRepresentation.d.ts +30 -0
  187. package/dist/types/src/generated/types/ManagedContentSpaceMemberInputRepresentation.d.ts +32 -0
  188. package/dist/types/src/generated/types/ManagedContentSpaceMemberPermissionsRepresentation.d.ts +38 -0
  189. package/dist/types/src/generated/types/ManagedContentSpaceMemberRepresentation.d.ts +35 -0
  190. package/dist/types/src/generated/types/ManagedContentSpacePermissionRepresentation.d.ts +53 -0
  191. package/dist/types/src/generated/types/ManagedContentSpaceRepresentation.d.ts +59 -0
  192. package/dist/types/src/generated/types/ManagedContentSpaceRoleCollectionRepresentation.d.ts +30 -0
  193. package/dist/types/src/generated/types/ManagedContentSpaceRoleRepresentation.d.ts +35 -0
  194. package/dist/types/src/generated/types/ManagedContentSpaceSummaryRepresentation.d.ts +32 -0
  195. package/dist/types/src/generated/types/ManagedContentTextNodeValueRepresentation.d.ts +30 -0
  196. package/dist/types/src/generated/types/ManagedContentTranslationRepresentation.d.ts +65 -0
  197. package/dist/types/src/generated/types/ManagedContentTranslationRequestInputRep.d.ts +38 -0
  198. package/dist/types/src/generated/types/ManagedContentTranslationV2Representation.d.ts +75 -0
  199. package/dist/types/src/generated/types/ManagedContentTranslationV2RequestInputRep.d.ts +50 -0
  200. package/dist/types/src/generated/types/ManagedContentTranslationV2RequestInputWrapperRep.d.ts +29 -0
  201. package/dist/types/src/generated/types/ManagedContentTypeRepresentation.d.ts +40 -0
  202. package/dist/types/src/generated/types/ManagedContentTypeSchemaRepresentation.d.ts +49 -0
  203. package/dist/types/src/generated/types/ManagedContentTypeSearchableCollectionRepresentation.d.ts +39 -0
  204. package/dist/types/src/generated/types/ManagedContentTypeSearchableInputRepresentation.d.ts +32 -0
  205. package/dist/types/src/generated/types/ManagedContentTypeSearchableRepresentation.d.ts +38 -0
  206. package/dist/types/src/generated/types/ManagedContentTypeSummaryRepresentation.d.ts +32 -0
  207. package/dist/types/src/generated/types/ManagedContentTypeViewRepresentation.d.ts +39 -0
  208. package/dist/types/src/generated/types/ManagedContentUnpublishInputRepresentation.d.ts +35 -0
  209. package/dist/types/src/generated/types/ManagedContentUnpublishInputWrapperRepresentation.d.ts +29 -0
  210. package/dist/types/src/generated/types/ManagedContentUnpublishOutputRepresentation.d.ts +45 -0
  211. package/dist/types/src/generated/types/ManagedContentUserSummaryRepresentation.d.ts +35 -0
  212. package/dist/types/src/generated/types/ManagedContentV2JobRepresentation.d.ts +75 -0
  213. package/dist/types/src/generated/types/ManagedContentV2JobRequestInputRepresentation.d.ts +35 -0
  214. package/dist/types/src/generated/types/ManagedContentVariantInputRepresentation.d.ts +45 -0
  215. package/dist/types/src/generated/types/ManagedContentVariantInputWrapperRepresentation.d.ts +29 -0
  216. package/dist/types/src/generated/types/ManagedContentVariantReferenceDetailsRepresentation.d.ts +67 -0
  217. package/dist/types/src/generated/types/ManagedContentVariantReferencesCollectionRepresentation.d.ts +35 -0
  218. package/dist/types/src/generated/types/ManagedContentVariantRepresentation.d.ts +95 -0
  219. package/dist/types/src/generated/types/ManagedContentVariantSearchResultRepresentation.d.ts +62 -0
  220. package/dist/types/src/generated/types/ManagedContentVariantStatusRepresentation.d.ts +32 -0
  221. package/dist/types/src/generated/types/ManagedContentVariantUpdateInputRepresentation.d.ts +39 -0
  222. package/dist/types/src/generated/types/ManagedContentVariantUpdateInputWrapperRepresentation.d.ts +29 -0
  223. package/dist/types/src/generated/types/ManagedContentVariantV1InputRep.d.ts +47 -0
  224. package/dist/types/src/generated/types/ManagedContentVariantV1Representation.d.ts +50 -0
  225. package/dist/types/src/generated/types/ManagedContentVariantVersionCollectionRepresentation.d.ts +49 -0
  226. package/dist/types/src/generated/types/ManagedContentVariantVersionRepresentation.d.ts +52 -0
  227. package/dist/types/src/generated/types/ManagedContentVersionCollectionRepresentation.d.ts +50 -0
  228. package/dist/types/src/generated/types/ManagedContentVersionInputRep.d.ts +51 -0
  229. package/dist/types/src/generated/types/ManagedContentVersionInternalCollectionRepresentation.d.ts +33 -0
  230. package/dist/types/src/generated/types/ManagedContentVersionInternalRepresentation.d.ts +81 -0
  231. package/dist/types/src/generated/types/ManagedContentVersionRepresentation.d.ts +65 -0
  232. package/dist/types/src/generated/types/ManagedContentVersionSiteNodeCollectionRepresentation.d.ts +30 -0
  233. package/dist/types/src/generated/types/ManagedContentVersionSiteNodeRepresentation.d.ts +41 -0
  234. package/dist/types/src/generated/types/ManagedContentVersionV2CollectionInputRepresentation.d.ts +29 -0
  235. package/dist/types/src/generated/types/ManagedContentVersionV2CollectionRepresentation.d.ts +33 -0
  236. package/dist/types/src/generated/types/ManagedContentVersionV2InputRepresentation.d.ts +54 -0
  237. package/dist/types/src/generated/types/ManagedContentVersionV2Representation.d.ts +75 -0
  238. package/dist/types/src/generated/types/ReferenceRepresentation.d.ts +26 -0
  239. package/dist/types/src/generated/types/StreamedRepresentation.d.ts +26 -0
  240. package/dist/types/src/generated/types/TopicSummaryRepresentation.d.ts +32 -0
  241. package/dist/types/src/generated/types/type-utils.d.ts +39 -0
  242. package/dist/types/src/raml-artifacts/adapters/getCollectionItems/onFetchResponseSuccess.d.ts +5 -0
  243. package/dist/types/src/raml-artifacts/adapters/getManagedContent/onFetchResponseSuccess.d.ts +5 -0
  244. package/dist/types/src/raml-artifacts/resources/postConnectCmsContents/ingestSuccess.d.ts +4 -0
  245. package/dist/umd/es2018/cms-authoring.js +6687 -0
  246. package/dist/umd/es5/cms-authoring.js +6726 -0
  247. package/package.json +72 -0
  248. package/sfdc/index.d.ts +1 -0
  249. package/sfdc/index.js +6878 -0
  250. package/src/raml/api.raml +4284 -0
  251. package/src/raml/luvio.raml +593 -0
@@ -0,0 +1,4284 @@
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/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
+ AbstractManagedContentReferencedByContributorRepresentation:
29
+ description: Representation of the contributor.
30
+ discriminator: type
31
+ type: object
32
+ properties:
33
+ contentType:
34
+ description: Content type of the contributor.
35
+ type: ManagedContentTypeSummaryRepresentation
36
+ id:
37
+ description: Id of the contributor.
38
+ type: string
39
+ isPublished:
40
+ description: is contributor published.
41
+ type: boolean
42
+ language:
43
+ description: language of the contributor.
44
+ type: string
45
+ title:
46
+ description: Title of the contributor.
47
+ type: string
48
+ type:
49
+ description: Type of the contributor.
50
+ type: string
51
+ enum:
52
+ - Variant
53
+ - VariantSnapshot
54
+ AbstractManagedContentReferencedByItemRepresentation:
55
+ description: Representation of the referencing entity.
56
+ discriminator: type
57
+ type: object
58
+ properties:
59
+ contentType:
60
+ description: Content type of the referencing source
61
+ type: ManagedContentTypeSummaryRepresentation
62
+ id:
63
+ description: Id of the source entity referencing this managed content.
64
+ type: string
65
+ networkId:
66
+ description: The network id that the site is associated with.
67
+ type: string
68
+ required: false # TODO handrolled W-9314597
69
+ referenceTypes:
70
+ description: List of reference types for this managed content.
71
+ type: array
72
+ items:
73
+ type: string
74
+ enum:
75
+ - Dependency
76
+ - Link
77
+ siteId:
78
+ description: The site id.
79
+ type: string
80
+ required: false # TODO handrolled W-9314597
81
+ siteName:
82
+ description: The name of the site.
83
+ type: string
84
+ required: false # TODO handrolled W-9314597
85
+ title:
86
+ description: Title of the source entity referencing this managed content.
87
+ type: string
88
+ type:
89
+ description: Type of the source entity referencing this managed content.
90
+ type: string
91
+ AbstractManagedContentSearchResultRepresentation:
92
+ description: A keyword-based search result for a Managed Content Variant or Folder.
93
+ discriminator: type
94
+ type: object
95
+ properties:
96
+ createdBy:
97
+ description: The user who created the managed content variant or folder.
98
+ type: ManagedContentUserSummaryRepresentation
99
+ createdDate:
100
+ description: The time the managed content variant or folder was created.
101
+ type: string
102
+ folder:
103
+ description: The content folder that this variant or folder resides in.
104
+ type: ManagedContentFolderSummaryRepresentation
105
+ id:
106
+ description: The ID of the managed content variant or folder.
107
+ type: string
108
+ lastModifiedBy:
109
+ description: The user who last modified the managed content variant or folder.
110
+ type: ManagedContentUserSummaryRepresentation
111
+ lastModifiedDate:
112
+ description: The last time the managed content variant or folder has been
113
+ modified.
114
+ type: string
115
+ managedContentSpaceId:
116
+ description: The content space of the managed content.
117
+ type: string
118
+ type:
119
+ description: The class name of this search result; may be used as a discriminator.
120
+ type: string
121
+ AbstractMCSFolderRepresentation:
122
+ description: Abstract Representation of a CMS Folder i.e. ManagedContentSpaceFolder
123
+ having only Id, Name, ParentFolderId
124
+ discriminator: representationType # TODO hand rolled. W-9275787
125
+ type: object
126
+ properties:
127
+ representationType:
128
+ description: Representation type.
129
+ type: string
130
+ enum:
131
+ - Summary
132
+ - Detail
133
+ id:
134
+ description: The ID of the folder - ManagedContentSpaceFolder
135
+ type: string
136
+ name:
137
+ description: The name of the folder
138
+ type: string
139
+ parentFolderId:
140
+ description: The ID of the folder's parent
141
+ type: string
142
+ AbstractMContentRepresentation:
143
+ description: Compact information about a content.
144
+ discriminator: representationType # TODO hand rolled. W-9275694
145
+ type: object
146
+ properties:
147
+ representationType:
148
+ description: Representation type.
149
+ type: string
150
+ enum:
151
+ - Summary
152
+ - Detail
153
+ contentKey:
154
+ description: The content key
155
+ type: string
156
+ contentUrlName:
157
+ description: The content url name of the managed content version.
158
+ type: string
159
+ language:
160
+ description: The language of the managed content version.
161
+ type: string
162
+ managedContentId:
163
+ description: The unique identifier of the managed content in the authoring
164
+ space.
165
+ type: string
166
+ publishedDate:
167
+ description: Get the date when the managed content version was last published.
168
+ type: string
169
+ title:
170
+ description: Get the title of the managed content version.
171
+ type: string
172
+ type:
173
+ description: The type of the managed content version.
174
+ type: string
175
+ typeLabel:
176
+ description: The type label of the managed content type.
177
+ type: string
178
+ CMSChannelRepresentation:
179
+ description: Details of a Managed Content Channel
180
+ type: object
181
+ properties:
182
+ channelId:
183
+ description: Id of the Managed Content Channel
184
+ type: string
185
+ channelName:
186
+ description: Name of the Managed Content Channel
187
+ type: string
188
+ channelType:
189
+ description: Type of Managed Content Channel
190
+ type: string
191
+ enum:
192
+ - CloudToCloud
193
+ - Community
194
+ - ConnectedApp
195
+ - PublicUnauthenticated
196
+ domain:
197
+ description: Domain assigned to the channel.
198
+ type: string
199
+ domainName:
200
+ description: Name of the domain assigned to the channel.
201
+ type: string
202
+ isChannelSearchable:
203
+ description: Enablement of Text Search of Channel's Contents
204
+ type: boolean
205
+ isDomainLocked:
206
+ description: If the channel domain is editable.
207
+ type: boolean
208
+ MCDeliveryV2VariantCollectionRepresentation:
209
+ description: The collection representing the list of managed content variant information
210
+ type: object
211
+ properties:
212
+ variants:
213
+ description: List of all variants
214
+ type: array
215
+ items:
216
+ type: MCDeliveryV2VariantRepresentation
217
+ MCDeliveryV2VariantInputRepresentation:
218
+ description: Input representation to get variants by content ids and variant key
219
+ type: object
220
+ properties:
221
+ contentIds:
222
+ description: List of contentIds to filter variants
223
+ type: array
224
+ items:
225
+ type: string
226
+ variantKey:
227
+ description: Variant Key to filter variants
228
+ type: string
229
+ MCDeliveryV2VariantRepresentation:
230
+ description: The output representation of a managed content variant detailed information
231
+ type: object
232
+ properties:
233
+ contentKey:
234
+ description: Content Key of the content
235
+ type: string
236
+ contentType:
237
+ description: Content type of the content
238
+ type: string
239
+ language:
240
+ description: Language of the variant
241
+ type: string
242
+ lastUpdatedBy:
243
+ description: Last updated by (user id) of the variant
244
+ type: string
245
+ managedContentId:
246
+ description: Id of the Managed Content
247
+ type: string
248
+ publishedDate:
249
+ description: Published Date of the variant
250
+ type: string
251
+ title:
252
+ description: Title of the variant
253
+ type: string
254
+ urlName:
255
+ description: UrlName of the variant
256
+ type: string
257
+ variantKey:
258
+ description: Variant Key of the variant
259
+ type: string
260
+ MCSiteContentCollectionRepresentation:
261
+ description: The collection representing the list of managed content detailed
262
+ information
263
+ type: object
264
+ properties:
265
+ contents:
266
+ description: List of all contents delivered to a site
267
+ type: array
268
+ items:
269
+ type: MCSiteContentRepresentation
270
+ MCSiteContentRepresentation:
271
+ description: The output representation of a managed content detailed information
272
+ type: object
273
+ properties:
274
+ children:
275
+ description: List of all immediate children of this content
276
+ type: array
277
+ items:
278
+ type: ManagedContentChildRepresentation
279
+ contentKey:
280
+ description: Content key of a Managed Content
281
+ type: string
282
+ contentType:
283
+ description: Type of a Managed Content
284
+ type: string
285
+ managedContentId:
286
+ description: Id of a Managed Content
287
+ type: string
288
+ parentContentKey:
289
+ description: Parent's Content key
290
+ type: string
291
+ variants:
292
+ description: List of variants of this content delivered
293
+ type: array
294
+ items:
295
+ type: MCSiteVariantRepresentation
296
+ MCSiteDeliveryByContentKeysInputRepresentation:
297
+ description: Input representation to fetch content by content keys
298
+ type: object
299
+ properties:
300
+ contentKeys:
301
+ description: List of Content keys to filter contents
302
+ type: array
303
+ items:
304
+ type: string
305
+ includeChildren:
306
+ description: Should include immediate children or not
307
+ type: boolean
308
+ MCSiteDeliveryByContentTypesInputRepresentation:
309
+ description: Input representation to fetch content by content types
310
+ type: object
311
+ properties:
312
+ contentTypes:
313
+ description: List of Content types to filter contents
314
+ type: array
315
+ items:
316
+ type: string
317
+ MCSiteDeliveryByNodesInputRepresentation:
318
+ description: Input representation to fetch content by content types
319
+ type: object
320
+ properties:
321
+ contentKey:
322
+ description: content key for a content to fetch nodes
323
+ type: string
324
+ nodeIds:
325
+ description: List of node Ids to filter from content
326
+ type: array
327
+ items:
328
+ type: string
329
+ MCSiteNodeCollectionRepresentation:
330
+ description: A list of node representations of a content
331
+ type: object
332
+ properties:
333
+ nodes:
334
+ description: List of nodes
335
+ type: array
336
+ items:
337
+ type: MCSiteNodeRepresentation
338
+ MCSiteNodeRepresentation:
339
+ description: The node representation of a content
340
+ type: object
341
+ properties:
342
+ contentKey:
343
+ description: Content key of a Managed Content
344
+ type: string
345
+ lastModifiedBy:
346
+ description: last modified by user of variant
347
+ type: string
348
+ nodes:
349
+ description: Map of variant key to node body
350
+ type: object
351
+ properties:
352
+ //:
353
+ type: string
354
+ publishDate:
355
+ description: published date of variant
356
+ type: string
357
+ variantKey:
358
+ description: variant key of a variant
359
+ type: string
360
+ MCSiteVariantRepresentation:
361
+ description: The variant representation of a content
362
+ type: object
363
+ properties:
364
+ body:
365
+ description: body of the variant delivered to a site
366
+ type: string
367
+ language:
368
+ description: language of the variant delivered to a site
369
+ type: string
370
+ lastUpdatedBy:
371
+ description: Last updated by user id of the variant delivered to a site
372
+ type: string
373
+ publishedDate:
374
+ description: published date of the variant delivered to a site
375
+ type: string
376
+ title:
377
+ description: title of the variant delivered to a site
378
+ type: string
379
+ urlName:
380
+ description: urlname/slug of the variant delivered to a site
381
+ type: string
382
+ variantKey:
383
+ description: Variant key of the variant delivered to a site
384
+ type: string
385
+ MContentBodyRepresentation:
386
+ description: Information about a managed content version.
387
+ type: object
388
+ properties:
389
+ body:
390
+ description: Content Body.
391
+ type: object
392
+ properties:
393
+ //:
394
+ type: object
395
+ MContentCollectionMetadataRepresentation:
396
+ description: Collection details.
397
+ type: object
398
+ properties:
399
+ description:
400
+ description: Decription of the collection schema.
401
+ type: string
402
+ schema:
403
+ description: Schema of the collection type.
404
+ type: object
405
+ properties:
406
+ //:
407
+ type: object
408
+ title:
409
+ description: Title of the collection schema.
410
+ type: string
411
+ MContentCollectionRepresentation:
412
+ description: Collection details.
413
+ type: object
414
+ properties:
415
+ contentKey:
416
+ description: The content key
417
+ type: string
418
+ currentPageUrl:
419
+ description: URL to the current page of collection details. The default is
420
+ 25 managed content versions per page.
421
+ type: string
422
+ description:
423
+ description: Decription of the collection.
424
+ type: string
425
+ items:
426
+ description: Managed content versions for this page.
427
+ type: array
428
+ items:
429
+ type: MContentDetailRepresentation
430
+ nextPageUrl:
431
+ description: URL to the next page of managed content versions, The default
432
+ is 25 managed content versions per page.
433
+ type: string
434
+ title:
435
+ description: Title of the collection.
436
+ type: string
437
+ total:
438
+ description: Total number of versions across all pages.
439
+ type: integer
440
+ type:
441
+ description: Type of the collection.
442
+ type: string
443
+ MContentDetailRepresentation:
444
+ description: Full information about a single content.
445
+ type: AbstractMContentRepresentation
446
+ properties:
447
+ contentBody:
448
+ description: Get the content body
449
+ type: MContentBodyRepresentation
450
+ MContentSummaryRepresentation:
451
+ description: Compact information about a content.
452
+ type: AbstractMContentRepresentation
453
+ properties: {}
454
+ ManagedContentAssociationsInputRep:
455
+ description: "Input Representation for associations for managed content. Describes\
456
+ \ how \n * a ManagedContent is organized. Examples are the list of topics that\
457
+ \ are \n * assigned to a ManagedContent and the folders in which the ManagedContent\
458
+ \ is placed. "
459
+ type: object
460
+ properties:
461
+ topics:
462
+ description: The names of topics to associate the Managed Content with. Set
463
+ to empty to remove all topic associations from the Managed Content.
464
+ type: array
465
+ items:
466
+ type: string
467
+ ManagedContentAssociationsRepresentation:
468
+ description: The Managed Content Associations, e.g. topic associations, describing
469
+ how this Managed Content is organized and discoverable
470
+ type: object
471
+ properties:
472
+ topics:
473
+ description: A collection of topics associated with this Managed Content.
474
+ type: array
475
+ items:
476
+ type: TopicSummaryRepresentation
477
+ ManagedContentBodyInputRep:
478
+ description: Input representation for the body of a managed content.
479
+ type: object
480
+ properties:
481
+ nodeMap:
482
+ description: The body of the managed content version.
483
+ type: object
484
+ properties:
485
+ //:
486
+ type: object
487
+ ManagedContentChannelSummaryRepresentation:
488
+ description: Contextual Information of the channel in managed content delivery
489
+ api
490
+ type: object
491
+ properties:
492
+ name:
493
+ description: Name of the managed content channel
494
+ type: string
495
+ resourceUrl:
496
+ description: Resource Url to fetch complete information of the channel
497
+ type: string
498
+ targetEntity:
499
+ description: Information of the Target Entity associated with this channel
500
+ type: ManagedContentChannelTargetEntitySummaryRepresentation
501
+ ManagedContentChannelTargetEntitySummaryRepresentation:
502
+ description: Contextual Information of the channel in managed content delivery
503
+ api
504
+ type: object
505
+ properties:
506
+ id:
507
+ description: Id of the target entity associated with the channel
508
+ type: string
509
+ ManagedContentChildRepresentation:
510
+ description: The representation of a child managed content
511
+ type: object
512
+ properties:
513
+ contentKey:
514
+ description: Content key of a Managed Content
515
+ type: string
516
+ contentType:
517
+ description: Type of a Managed Content
518
+ type: string
519
+ managedContentId:
520
+ description: Id of a Managed Content
521
+ type: string
522
+ ManagedContentCollectionDetailRepresentation:
523
+ description: Information about collection Items for authoring.
524
+ type: object
525
+ properties:
526
+ collectionKey:
527
+ description: The collection key
528
+ type: string
529
+ collectionType:
530
+ description: Type of the collection.
531
+ type: ManagedContentTypeSummaryRepresentation
532
+ id:
533
+ description: The id of the collection
534
+ type: string
535
+ isPublished:
536
+ description: Published Date of the collection.
537
+ type: boolean
538
+ items:
539
+ description: Collection Items for this page.
540
+ type: array
541
+ items:
542
+ type: ManagedContentCollectionItemRepresentation
543
+ language:
544
+ description: language of the collection.
545
+ type: string
546
+ title:
547
+ description: Title of the collection.
548
+ type: string
549
+ total:
550
+ description: Total number of items in current collection detail page.
551
+ type: integer
552
+ urlName:
553
+ description: URL Name of the collection.
554
+ type: string
555
+ versionNumber:
556
+ description: The version number of the managed content collection.
557
+ type: string
558
+ ManagedContentCollectionItemRepresentation:
559
+ description: Compact information about a content.
560
+ type: object
561
+ properties:
562
+ body:
563
+ description: Get the content body of collection item
564
+ type: object
565
+ properties:
566
+ //:
567
+ type: any # TODO W-8863405 Hand Rolled
568
+ contentType:
569
+ description: The type of the collection item.
570
+ type: ManagedContentCollectionItemTypeSummaryRepresentation
571
+ id:
572
+ description: The unique identifier of collection item.
573
+ type: string
574
+ name:
575
+ description: The name or title for collection item
576
+ type: string
577
+ ManagedContentCollectionItemTypeSummaryRepresentation:
578
+ description: Information about a collection item type.
579
+ type: object
580
+ properties:
581
+ fullyQualifiedName:
582
+ description: Fully qualified name of collection item type.
583
+ type: string
584
+ name:
585
+ description: Name of collection item type.
586
+ type: string
587
+ ManagedContentCollectionRepresentation:
588
+ description: The output representation of a list of contents
589
+ type: object
590
+ properties:
591
+ contents:
592
+ description: List of contents
593
+ type: array
594
+ items:
595
+ type: ManagedContentRepresentation
596
+ ManagedContentDateAndTimeNodeValueRepresentation:
597
+ description: Information about a managed content node of datetime type.
598
+ type: ManagedContentNodeValueRepresentation
599
+ properties:
600
+ dateTimeValue:
601
+ description: The DateTime value in UTC of the managed content node.
602
+ type: string
603
+ timeZone:
604
+ description: The TimeZone in which DateTime is authored of the managed content
605
+ node.
606
+ type: string
607
+ ManagedContentDateNodeValueRepresentation:
608
+ description: Information about a managed content node of type date.
609
+ type: ManagedContentNodeValueRepresentation
610
+ properties:
611
+ value:
612
+ description: The date value of the managed content node.
613
+ type: string
614
+ ManagedContentDeploymentCollectionRepresentation:
615
+ description: Collection of Deployments
616
+ type: object
617
+ properties:
618
+ currentPageUrl:
619
+ description: URL to the current page of Manage Content deployment records.
620
+ type: string
621
+ deployments:
622
+ description: ManagedContentDeployment collection
623
+ type: array
624
+ items:
625
+ type: ManagedContentDeploymentRepresentation
626
+ nextPageUrl:
627
+ description: URL to the next page of Manage Content deployment records.
628
+ type: string
629
+ previousPageUrl:
630
+ description: URL to the previous page of Managed Content deployment records.
631
+ type: string
632
+ ManagedContentDeploymentInputRepresentation:
633
+ description: Input required for creating a deployment
634
+ type: object
635
+ properties:
636
+ channelIds:
637
+ description: '[Optional] The target channel to publish content to.'
638
+ type: array
639
+ items:
640
+ type: string
641
+ required: false # TODO handrolled W-9314597
642
+ contentIds:
643
+ description: '[Optional] The contents to publish. Not valid to have both contentIds and variantIds.'
644
+ type: array
645
+ items:
646
+ type: string
647
+ required: false # TODO handrolled W-9314597
648
+ contentSpaceId:
649
+ description: The content space to publish content from.
650
+ type: string
651
+ description:
652
+ description: Description for deployment.
653
+ type: string
654
+ required: false # TODO handrolled W-9314597
655
+ executeStagedDeployments:
656
+ description: '[Optional] Execute all staged deployments.'
657
+ type: boolean
658
+ required: false # TODO handrolled W-9314597
659
+ includeContentReferences:
660
+ description: '[Optional] Include Content References for deployment.'
661
+ type: boolean
662
+ required: false # TODO handrolled W-10340822
663
+ scheduledDate:
664
+ description: '[Optional] Scheduled date for deployment.'
665
+ type: string
666
+ required: false # TODO handrolled W-9314597
667
+ variantIds:
668
+ description: '[Optional] The variants to publish. Not valid to have both contentIds and variantIds'
669
+ type: array
670
+ items:
671
+ type: string
672
+ required: false # TODO handrolled W-10340822
673
+ ManagedContentDeploymentInputWrapperRepresentation: # TODO Hand-rolled W-8334626
674
+ description: wrapper for Input required for creating a deployment
675
+ type: object
676
+ properties:
677
+ DeploymentInput:
678
+ type: ManagedContentDeploymentInputRepresentation
679
+ ManagedContentDeploymentItemRepresentation:
680
+ description: Information about a deploymentItem
681
+ type: object
682
+ properties:
683
+ action:
684
+ description: Action for the ITEM
685
+ type: string
686
+ deploymentId:
687
+ description: ManagedContentDeployment Entity Id
688
+ type: string
689
+ deploymentItemId:
690
+ description: ManagedContentDeploymentItem Entity Id
691
+ type: string
692
+ snapshotId:
693
+ description: Snapshot Entity Id
694
+ type: string
695
+ targetId:
696
+ description: Target Entity Id
697
+ type: string | nil
698
+ ManagedContentDeploymentRepresentation:
699
+ description: Information about a Deployment
700
+ type: object
701
+ properties:
702
+ createdBy:
703
+ description: ManagedContentDeployment record creator user Id
704
+ type: string | nil
705
+ deploymentDescription:
706
+ description: ManagedContentDeployment Description
707
+ type: string | nil
708
+ deploymentId:
709
+ description: ManagedContentDeployment Entity Id
710
+ type: string
711
+ deploymentItems:
712
+ description: ManagedContentDeploymentItem list
713
+ type: array
714
+ items:
715
+ type: ManagedContentDeploymentItemRepresentation
716
+ deploymentName:
717
+ description: ManagedContentDeployment Name
718
+ type: string | nil
719
+ deploymentStatus:
720
+ description: ManagedContentDeployment Status
721
+ type: string | nil
722
+ lastModifiedBy:
723
+ description: ManagedContentDeployment record Last Modified user Id
724
+ type: string | nil
725
+ scheduledDate:
726
+ description: ManagedContentDeployment Scheduled Date
727
+ type: string | nil
728
+ ManagedContentDetailCollectionRepresentation:
729
+ description: Collection of ManagedContentDetailCollection
730
+ type: object
731
+ properties:
732
+ managedContentRecords:
733
+ description: Managed Content Details
734
+ type: array
735
+ items:
736
+ type: ManagedContentDetailRepresentation
737
+ totalItem:
738
+ description: Total count of records
739
+ type: integer
740
+ ManagedContentDetailRepresentation:
741
+ description: Details of a Managed Content
742
+ type: object
743
+ properties:
744
+ contentKey:
745
+ description: Content Key
746
+ type: string
747
+ managedContentId:
748
+ description: Id of the Managed Content
749
+ type: string
750
+ managedContentSpaceId:
751
+ description: Id Managed Content Space
752
+ type: string
753
+ managedContentVersionId:
754
+ description: Id of the Managed Content Version
755
+ type: string
756
+ ManagedContentDocumentDeliveryRepresentation:
757
+ description: Information about a managed content in delivery scope
758
+ type: object
759
+ properties:
760
+ channelInfo:
761
+ description: The contextual information of the managed content channel
762
+ type: ManagedContentChannelSummaryRepresentation
763
+ contentBody:
764
+ description: Body contains fields defined in the managed content type schema
765
+ of this managed content.
766
+ type: object
767
+ properties:
768
+ //:
769
+ type: object
770
+ contentKey:
771
+ description: Globally unique identifier of a managed content and doesn't change
772
+ when managed content is moved between production and sandbox environments.
773
+ type: string
774
+ contentType:
775
+ description: The type of the managed content.
776
+ type: ManagedContentTypeSummaryRepresentation
777
+ language:
778
+ description: The language of the managed content.
779
+ type: string
780
+ managedContentId:
781
+ description: Id of the managed content.
782
+ type: string
783
+ publishedDate:
784
+ description: The last time the managed content has been published.
785
+ type: string
786
+ title:
787
+ description: The title of the managed content.
788
+ type: string
789
+ urlName:
790
+ description: The content url name of the managed content.
791
+ type: string
792
+ ManagedContentDocumentRepresentation:
793
+ description: Information about a managed content in authoring space.
794
+ type: object
795
+ properties:
796
+ contentBody:
797
+ description: Body contains fields defined in the managed content type schema
798
+ of this managed content.
799
+ type: object
800
+ properties:
801
+ //:
802
+ type: any # TODO hand rolled. TD-0100382
803
+ contentKey:
804
+ description: Globally unique identifier of a managed content and doesn't change
805
+ when managed content is moved between production and sandbox environments.
806
+ type: string
807
+ contentSpace:
808
+ description: The content space of the managed content.
809
+ type: ManagedContentSpaceSummaryRepresentation
810
+ contentType:
811
+ description: The type of the managed content.
812
+ type: ManagedContentTypeSummaryRepresentation
813
+ createdBy:
814
+ description: The user who created the managed content.
815
+ type: ManagedContentUserSummaryRepresentation
816
+ createdDate:
817
+ description: The created date of the managed content.
818
+ type: string
819
+ folder:
820
+ description: The content folder of the managed content.
821
+ type: ManagedContentFolderSummaryRepresentation
822
+ isPublished:
823
+ description: Is managed content variant published to any channel.
824
+ type: boolean
825
+ language:
826
+ description: The language of the managed content.
827
+ type: string
828
+ lastModifiedBy:
829
+ description: The last user who has modified the managed content.
830
+ type: ManagedContentUserSummaryRepresentation
831
+ lastModifiedDate:
832
+ description: The last time the managed content has been modified.
833
+ type: string
834
+ managedContentId:
835
+ description: Id of the managed content in authoring space.
836
+ type: string
837
+ managedContentVariantId:
838
+ description: The managed content variant in the authoring space.
839
+ type: string
840
+ managedContentVersionId:
841
+ description: Version id of the managed content version.
842
+ type: string
843
+ title:
844
+ description: The title of the managed content.
845
+ type: string
846
+ urlName:
847
+ description: The content url name of the managed content.
848
+ type: string
849
+ versionNumber:
850
+ description: The version number of the managed content.
851
+ type: string | nil
852
+ version:
853
+ description: This is computed property that contains either v1 version id or v2 version number. It is not returned from the server and computed on the client side.
854
+ type: string
855
+ status:
856
+ description: The status of the managed content variant.
857
+ type: ManagedContentVariantStatusRepresentation | nil
858
+ required: false # TODO handrolled W-9314597
859
+ ManagedContentExportContentJobRequestInputRepresentation:
860
+ description: Input representation for creating a ManagedContent export job
861
+ type: object
862
+ properties:
863
+ contentSpaceId:
864
+ description: Managed Content Space Id
865
+ type: string
866
+ folderIds:
867
+ description: Collection of managed Content folder Ids
868
+ type: array
869
+ items:
870
+ type: string
871
+ includeReferenceContent:
872
+ description: The indicator to export the referenced content
873
+ type: boolean
874
+ managedContentIds:
875
+ description: Collection of managed Content Ids
876
+ type: array
877
+ items:
878
+ type: string
879
+ name:
880
+ description: Managed Content Export Job Name
881
+ type: string
882
+ parentFolderId:
883
+ description: Parent FolderId of Managed Content Export data
884
+ type: string
885
+ ManagedContentExportJobItemIdsInputList:
886
+ description: ManagedContentExportJobItemIdsInputRepresentation list object
887
+ type: object
888
+ properties:
889
+ ids:
890
+ description: The id value.
891
+ type: array
892
+ items:
893
+ type: string
894
+ ManagedContentFolderSearchResultRepresentation:
895
+ description: A keyword-based search result for a Managed Content Folder
896
+ type: AbstractManagedContentSearchResultRepresentation
897
+ properties:
898
+ name:
899
+ description: The name of the managed content folder.
900
+ type: string
901
+ ManagedContentFolderSummaryRepresentation:
902
+ description: Information about a managed content folder.
903
+ type: object
904
+ properties:
905
+ id:
906
+ description: Id of the managed content folder in the authoring space.
907
+ type: string
908
+ resourceUrl:
909
+ description: Connect API resource url to get more information about managed
910
+ content folder.
911
+ type: string
912
+ ManagedContentInputRep:
913
+ description: Input representation for a managed content
914
+ type: object
915
+ properties:
916
+ connectManagedContentStatusEnum:
917
+ description: The published status the user wants to patch the latest version
918
+ the content to
919
+ type: string
920
+ publishedVersionId:
921
+ description: The published version id of the managed content.
922
+ type: string
923
+ ManagedContentInputWrapperRepresentation: # TODO Hand-rolled W-8334626
924
+ description: wrapper for Input required for creating a variant
925
+ type: object
926
+ properties:
927
+ ManagedContentInputParam:
928
+ type: ManagedContentInputRepresentation
929
+ ManagedContentInputRepresentation:
930
+ description: 'Input representation for a managed content '
931
+ type: object
932
+ properties:
933
+ contentBody:
934
+ description: The body of the managed content.
935
+ type: object
936
+ properties:
937
+ //:
938
+ type: any # TODO hand rolled. TD-0100382
939
+ contentSpaceOrFolderId:
940
+ description: Content space or folder id where content will be created.
941
+ type: string
942
+ contentType:
943
+ description: Fully qualified name of the content type to create. This field
944
+ is required.
945
+ type: string
946
+ title:
947
+ description: The title of the managed content.
948
+ type: string
949
+ urlName:
950
+ description: URL-friendly identifier of the content within the org.
951
+ type: string
952
+ ManagedContentJobRepresentation:
953
+ description: Information about a managed content import/export job
954
+ type: object
955
+ properties:
956
+ createdBy:
957
+ description: The user id who created the managed content job
958
+ type: string
959
+ createdDate:
960
+ description: The created date of the managed content job
961
+ type: string
962
+ errorBodyUrl:
963
+ description: The URL to get the error content body of a managed content job
964
+ type: string
965
+ id:
966
+ description: The id of a managed content job
967
+ type: string
968
+ inputBodyUrl:
969
+ description: The URL to get the input content body of a managed content job
970
+ type: string
971
+ jobType:
972
+ description: The type of a managed content job
973
+ type: string
974
+ enum:
975
+ - Export
976
+ - Import
977
+ lastModifiedBy:
978
+ description: The last user id who has modified the managed content job
979
+ type: string
980
+ lastModifiedDate:
981
+ description: The last time the managed content job has been modified
982
+ type: string
983
+ lastStatusUpdateDate:
984
+ description: The last status update date of a managed content job
985
+ type: string
986
+ name:
987
+ description: The name of a managed content job
988
+ type: string
989
+ outputBodyUrl:
990
+ description: The URL to get the output content body of a managed content job
991
+ type: string
992
+ startDate:
993
+ description: The start date of a managed content job
994
+ type: string
995
+ status:
996
+ description: The status of a managed content job
997
+ type: string
998
+ enum:
999
+ - Completed
1000
+ - CompletedWithError
1001
+ - Created
1002
+ - Failed
1003
+ - Pending
1004
+ - Processing
1005
+ ManagedContentJobRequestInputRepresentation:
1006
+ description: Input representation for creating a ManagedContent import/export
1007
+ job
1008
+ type: object
1009
+ properties:
1010
+ autoPublish:
1011
+ description: Auto publish the data after import if that operation is permitted
1012
+ type: boolean
1013
+ contentBodyId:
1014
+ description: ContentBody Id of Managed Content Import data
1015
+ type: string
1016
+ contentSpaceId:
1017
+ description: Managed Content Space Id
1018
+ type: string
1019
+ includeContentKey:
1020
+ description: Update existing content after importing data if it exists by
1021
+ including content key; Otherwise create new content
1022
+ type: boolean
1023
+ name:
1024
+ description: Managed Content Job Name
1025
+ type: string
1026
+ ManagedContentLanguageSummaryRepresentation:
1027
+ description: Display Label for Language and language locale
1028
+ type: object
1029
+ properties:
1030
+ displayLabel:
1031
+ description: Display Label for Language of a managed content variant.
1032
+ type: string
1033
+ locale:
1034
+ description: Language locale of a managed content variant.
1035
+ type: string
1036
+ ManagedContentMediaNodeValueRepresentation:
1037
+ description: Information about a managed content node of media type.
1038
+ type: ManagedContentNodeValueRepresentation
1039
+ properties:
1040
+ altText:
1041
+ description: The alternate text for the managed content node.
1042
+ type: string
1043
+ contentKey:
1044
+ description: The contentKey of managed content being referenced.
1045
+ type: string
1046
+ fileName:
1047
+ description: The file name of the managed content node.
1048
+ type: string
1049
+ mediaType:
1050
+ description: The media type of the managed content node like Image, Video
1051
+ or Document
1052
+ type: string
1053
+ enum:
1054
+ - Document
1055
+ - Image
1056
+ - Video
1057
+ mimeType:
1058
+ description: The mime type of the managed content node.
1059
+ type: string
1060
+ resourceUrl:
1061
+ description: The resource url of the managed content node.
1062
+ type: string
1063
+ thumbnailUrl:
1064
+ description: Media thumbnail url.
1065
+ type: string
1066
+ title:
1067
+ description: The title of the managed content node.
1068
+ type: string
1069
+ unauthenticatedUrl:
1070
+ description: The unauthenticated url of the managed content node.
1071
+ type: string
1072
+ url:
1073
+ description: The url of the managed content node.
1074
+ type: string
1075
+ ManagedContentMediaSourceNodeValueRepresentation:
1076
+ description: Information about a source of a managed content media.
1077
+ type: ManagedContentNodeValueRepresentation
1078
+ properties:
1079
+ fileName:
1080
+ description: The file name of the media source.
1081
+ type: string
1082
+ isExternal:
1083
+ description: Whether media source is uploaded or referenced via external url.
1084
+ type: boolean
1085
+ mediaType:
1086
+ description: The type of media like Image, Video or Document.
1087
+ type: string
1088
+ enum:
1089
+ - Document
1090
+ - Image
1091
+ - Video
1092
+ mimeType:
1093
+ description: The mime type of the media source.
1094
+ type: string
1095
+ referenceId:
1096
+ description: Reference id of the uploaded media source
1097
+ type: string
1098
+ resourceUrl:
1099
+ description: The API url to the bytes of the media source.
1100
+ type: string
1101
+ unauthenticatedUrl:
1102
+ description: The url to the bytes of the media source for unauthenticated
1103
+ users.
1104
+ type: string
1105
+ url:
1106
+ description: The url to the bytes of the source for authenticated users.
1107
+ type: string
1108
+ ManagedContentNodeTypeRepresentation:
1109
+ description: Information about a managed content node type.
1110
+ type: object
1111
+ properties:
1112
+ label:
1113
+ description: The label of the managed content node type.
1114
+ type: string
1115
+ name:
1116
+ description: The developer name of the managed content node type.
1117
+ type: string
1118
+ nodeType:
1119
+ description: The type of the managed content node.
1120
+ type: string
1121
+ enum:
1122
+ - Date
1123
+ - DateTime
1124
+ - Media
1125
+ - MediaSource
1126
+ - MultilineText
1127
+ - NameField
1128
+ - RichText
1129
+ - Text
1130
+ - Url
1131
+ ManagedContentNodeValueRepresentation:
1132
+ description: Information about a managed content node.
1133
+ type: object
1134
+ discriminator: nodeType # TODO hand rolled. W-9275694
1135
+ properties:
1136
+ nodeType:
1137
+ description: The type of the managed content node.
1138
+ type: string
1139
+ enum:
1140
+ - Date
1141
+ - DateTime
1142
+ - Media
1143
+ - MediaSource
1144
+ - MultilineText
1145
+ - NameField
1146
+ - RichText
1147
+ - Text
1148
+ - Url
1149
+ ManagedContentPreviewCollectionRepresentation:
1150
+ description: Collection of Managed Content Previews
1151
+ type: object
1152
+ properties:
1153
+ previews:
1154
+ description: ManagedContentPreview collection
1155
+ type: array
1156
+ items:
1157
+ type: ManagedContentPreviewRepresentation
1158
+ ManagedContentPreviewRepresentation:
1159
+ description: Information about a Managed Content Preview
1160
+ type: object
1161
+ properties:
1162
+ channelName:
1163
+ description: ManagedContent channel name
1164
+ type: string
1165
+ previewEndpoint:
1166
+ description: ManagedContent previewEndpoint
1167
+ type: string
1168
+ ManagedContentPublishInputRepresentation:
1169
+ description: Input required for publishing content
1170
+ type: object
1171
+ properties:
1172
+ contentIds:
1173
+ description: '[Optional] The contents to publish. Either contentIds or variantIds
1174
+ is required.'
1175
+ type: array
1176
+ required: false # TODO Hand-rolled W-11613845
1177
+ items:
1178
+ type: string
1179
+ description:
1180
+ description: Description for publish Action.
1181
+ type: string
1182
+ required: false # TODO Hand-rolled W-11613845
1183
+ includeContentReferences:
1184
+ description: '[Optional] Include Content References for deployment.'
1185
+ type: boolean
1186
+ required: false # TODO Hand-rolled W-11613845
1187
+ variantIds:
1188
+ description: '[Optional] The variants to publish. Either contentIds or variantIds
1189
+ is required.'
1190
+ type: array
1191
+ required: false # TODO Hand-rolled W-11613845
1192
+ items:
1193
+ type: string
1194
+ ManagedContentPublishInputWrapperRepresentation: # TODO Hand-rolled W-11613845
1195
+ description: Wrapper for Input required for publish managed content or variants
1196
+ type: object
1197
+ properties:
1198
+ publishInput:
1199
+ type: ManagedContentPublishInputRepresentation
1200
+ ManagedContentPublishOutputRepresentation:
1201
+ description: Information about a Publish action
1202
+ type: object
1203
+ properties:
1204
+ deploymentId:
1205
+ description: ManagedContentDeployment Entity Id
1206
+ type: string
1207
+ description:
1208
+ description: Provided description.
1209
+ type: string | nil
1210
+ publishDate:
1211
+ description: Publish Date
1212
+ type: string | nil
1213
+ ManagedContentReferencedByCollectionRepresentation:
1214
+ description: Collection of rof referencing contents
1215
+ type: object
1216
+ properties:
1217
+ currentPageUrl:
1218
+ description: URL to the current page of managed content references. The default
1219
+ is 25 managed content references per page.
1220
+ type: string
1221
+ nextPageUrl:
1222
+ description: URL to the next page of managed content references, The default
1223
+ is 25 managed content references per page.
1224
+ type: string | nil
1225
+ referencedBy:
1226
+ description: Managed content referenceBy for this page.
1227
+ type: array
1228
+ items:
1229
+ type: AbstractManagedContentReferencedByItemRepresentation
1230
+ total:
1231
+ description: Total number of referencedBy contents across all pages.
1232
+ type: integer
1233
+ ManagedContentReferencedByContributorItemRepresentation:
1234
+ description: Representation of the contributor item.
1235
+ type: object
1236
+ properties:
1237
+ createdBy:
1238
+ description: User who contributed the reference from this contributor item
1239
+ to managed content.
1240
+ type: ManagedContentUserSummaryRepresentation
1241
+ createdDate:
1242
+ description: Date when the reference from this contributor item to the managed
1243
+ content was created.
1244
+ type: string
1245
+ id:
1246
+ description: Id of the contributor item
1247
+ type: string
1248
+ referenceType:
1249
+ description: Reference type of the contributor item.
1250
+ type: string
1251
+ enum:
1252
+ - Dependency
1253
+ - Link
1254
+ ManagedContentReferencedByContributorRepresentation:
1255
+ description: Representation of the contributor
1256
+ type: AbstractManagedContentReferencedByContributorRepresentation
1257
+ properties:
1258
+ createdBy:
1259
+ description: User who created the reference.
1260
+ type: ManagedContentUserSummaryRepresentation
1261
+ createdDate:
1262
+ description: Date reference created
1263
+ type: string
1264
+ referenceType:
1265
+ description: Reference type of the contributor
1266
+ type: string
1267
+ enum:
1268
+ - Dependency
1269
+ - Link
1270
+ ManagedContentReferencedByContributorWithContributorItemsRepresentation:
1271
+ description: Representation of the contributor with contributor items
1272
+ type: AbstractManagedContentReferencedByContributorRepresentation
1273
+ properties:
1274
+ contributorItems:
1275
+ description: List of contributor items
1276
+ type: array
1277
+ items:
1278
+ type: ManagedContentReferencedByContributorItemRepresentation
1279
+ ManagedContentReferencedByItemRepresentation:
1280
+ description: Representation of the contributor
1281
+ type: AbstractManagedContentReferencedByItemRepresentation
1282
+ properties: {}
1283
+ ManagedContentReferencedByRecordRepresentation:
1284
+ description: Representation of the referencing entity
1285
+ type: AbstractManagedContentReferencedByItemRepresentation
1286
+ properties:
1287
+ createdBy:
1288
+ description: User who created this reference.
1289
+ type: ManagedContentUserSummaryRepresentation
1290
+ createdDate:
1291
+ description: Date when this reference was created.
1292
+ type: string
1293
+ ManagedContentReferencedByVariantRepresentation:
1294
+ description: Representation for the managed content variant referencing managed
1295
+ content.
1296
+ type: AbstractManagedContentReferencedByItemRepresentation
1297
+ properties:
1298
+ contributors:
1299
+ description: Contributor list
1300
+ type: array
1301
+ items:
1302
+ type: AbstractManagedContentReferencedByContributorRepresentation
1303
+ ManagedContentRenditionRepresentation:
1304
+ description: Information about a rendition of CMS content
1305
+ type: object
1306
+ properties:
1307
+ contentKey:
1308
+ description: Globally unique identifier of a managed content
1309
+ type: string
1310
+ managedContentId:
1311
+ description: Id of the managed content.
1312
+ type: string
1313
+ language:
1314
+ description: The language of the managed content.
1315
+ type: string
1316
+ renditionBody:
1317
+ description: Body containing rendition of content
1318
+ type: object
1319
+ properties:
1320
+ //:
1321
+ type: any
1322
+ renditionSchema:
1323
+ description: Schema of rendition
1324
+ type: object
1325
+ properties:
1326
+ //:
1327
+ type: any
1328
+ ManagedContentRepresentation:
1329
+ description: The output representation of a managed content
1330
+ type: object
1331
+ properties:
1332
+ contentKey:
1333
+ description: Content key of a Managed Content
1334
+ type: string
1335
+ contentType:
1336
+ description: Content type of a Managed Content
1337
+ type: string
1338
+ ManagedContentScheduleInputRepresentation:
1339
+ description: Input required for creating a scheduled deployment in 232
1340
+ type: object
1341
+ properties:
1342
+ action:
1343
+ description: Action can be Publish/Unpublish for deployment
1344
+ type: string
1345
+ enum:
1346
+ - Publish
1347
+ - Unpublish
1348
+ authorSpaceId:
1349
+ description: Authoring managed content space id where the deployment will
1350
+ be scheduled
1351
+ type: string
1352
+ description:
1353
+ description: Name of the deployment
1354
+ type: string
1355
+ expireDate:
1356
+ description: Expiry date of the schedule
1357
+ type: string
1358
+ publishContentReference:
1359
+ description: PublishContentReference will help publish the reference item
1360
+ type: boolean
1361
+ scheduleDate:
1362
+ description: Setting the schedule date for the deployment
1363
+ type: string
1364
+ versionIds:
1365
+ description: For unpublish we need to set the versionIds
1366
+ type: array
1367
+ items:
1368
+ type: string
1369
+ ManagedContentSearchResultCollectionRepresentation:
1370
+ description: A container of paginated cms keyword-based search result items plus
1371
+ a short search result summary
1372
+ type: object
1373
+ properties:
1374
+ count:
1375
+ description: total search result item count
1376
+ type: integer
1377
+ currentPageUri:
1378
+ description: search result URI
1379
+ type: string
1380
+ items:
1381
+ description: an array of search result items
1382
+ type: array
1383
+ items:
1384
+ type: ManagedContentSearchResultRepresentation
1385
+ nextPageUri:
1386
+ description: next search result URI
1387
+ type: string
1388
+ ManagedContentSearchResultContentTypeRepresentation:
1389
+ description: A keyword-based search result item's content type
1390
+ type: object
1391
+ properties:
1392
+ developerName:
1393
+ description: managed content type developer name
1394
+ type: string
1395
+ label:
1396
+ description: managed content type label
1397
+ type: string
1398
+ ManagedContentSearchResultItemsCollectionRepresentation:
1399
+ description: A container of paginated CMS keyword-based search result variant
1400
+ and folder items plus a short search result summary
1401
+ type: object
1402
+ properties:
1403
+ count:
1404
+ description: The total count of search results.
1405
+ type: integer
1406
+ currentPageUri:
1407
+ description: The URI for the current page of search results.
1408
+ type: string
1409
+ items:
1410
+ description: A list of search result items.
1411
+ type: array
1412
+ items:
1413
+ type: AbstractManagedContentSearchResultRepresentation
1414
+ nextPageUri:
1415
+ description: The URI for the next page of search results.
1416
+ type: string
1417
+ ManagedContentSearchResultRepresentation:
1418
+ description: A keyword-based search result item
1419
+ type: object
1420
+ properties:
1421
+ contentKey:
1422
+ description: managed content content key
1423
+ type: string
1424
+ contentType:
1425
+ description: managed content content type
1426
+ type: ManagedContentSearchResultContentTypeRepresentation
1427
+ id:
1428
+ description: managed content id
1429
+ type: string
1430
+ publishDate:
1431
+ description: managed content published date
1432
+ type: string
1433
+ title:
1434
+ description: managed content title
1435
+ type: string
1436
+ urlName:
1437
+ description: managed content (version) url name
1438
+ type: string
1439
+ ManagedContentSpaceCollectionRepresentation:
1440
+ description: Collection of Managed Content Spaces
1441
+ type: object
1442
+ properties:
1443
+ spaces:
1444
+ description: ManagedContentSpace records corresponding to the current page.
1445
+ type: array
1446
+ items:
1447
+ type: ManagedContentSpaceRepresentation
1448
+ ManagedContentSpaceFolderDetailRepresentation:
1449
+ description: Detail Representation of a CMS Folder i.e. ManagedContentSpaceFolder
1450
+ type: AbstractMCSFolderRepresentation
1451
+ properties:
1452
+ createdBy:
1453
+ description: The User ID of the user who created the folder
1454
+ type: string
1455
+ createdDate:
1456
+ description: The date when the folder was created
1457
+ type: string
1458
+ folderHierarchy:
1459
+ description: The list of the parent folders in the hierarchy - starting from
1460
+ the root upto the direct parent of the folder
1461
+ type: array
1462
+ items:
1463
+ type: ManagedContentSpaceFolderRepresentation
1464
+ lastModifiedBy:
1465
+ description: The User ID of the user who last modified the folder
1466
+ type: string
1467
+ lastModifiedDate:
1468
+ description: The date when the folder was last modified
1469
+ type: string
1470
+ ManagedContentSpaceFolderInputRep:
1471
+ description: Input representation of a content space folder
1472
+ type: object
1473
+ properties:
1474
+ name:
1475
+ description: The name of the folder
1476
+ type: string
1477
+ parentFolderId:
1478
+ description: Parent folder id
1479
+ type: string
1480
+ ManagedContentSpaceFolderItemCollectionInputRep:
1481
+ description: Collection input of ManagedContentSpaceFolderItems for Move operation
1482
+ type: object
1483
+ properties:
1484
+ folderId:
1485
+ description: ID of the new parent folder to the items should be moved
1486
+ type: string
1487
+ folderItems:
1488
+ description: List of IDs of the folder items that need to be moved
1489
+ type: array
1490
+ items:
1491
+ type: string
1492
+ ManagedContentSpaceFolderItemCollectionRepresentation:
1493
+ description: Collection Representation of folder items inside in ManagedContentSpaceFolder
1494
+ type: object
1495
+ properties:
1496
+ folderId:
1497
+ description: The id of the folder
1498
+ type: string
1499
+ folderItems:
1500
+ description: The list of the folder items - ManagedContent or ManagedContentSpaceFolder
1501
+ type: array
1502
+ items:
1503
+ type: ManagedContentSpaceFolderItemRepresentation
1504
+ parentFolderId:
1505
+ description: The id of the parent folder
1506
+ type: string | nil # TODO hand rolled --> see: W-9965762
1507
+ ManagedContentSpaceFolderItemRepresentation:
1508
+ description: Representation of a folder item inside a ManagedContentSpaceFolder
1509
+ type: object
1510
+ properties:
1511
+ contentKey:
1512
+ description: The ContentKey of the ManagedContent
1513
+ type: string
1514
+ required: false # TODO hand rolled --> see: W-9965762
1515
+ contentType:
1516
+ description: Developer Name or FQN for the ManagedContentType if the folder
1517
+ item is ManagedContent
1518
+ type: ManagedContentTypeSummaryRepresentation
1519
+ required: false # TODO hand rolled --> see: W-9965762
1520
+ createdBy:
1521
+ description: The User ID for the user which created the ManagedContent or
1522
+ ManagedContentSpaceFolder
1523
+ type: string
1524
+ createdDate:
1525
+ description: The date when the ManagedContent or ManagedContentSpaceFolder
1526
+ was created
1527
+ type: string
1528
+ hasChildFolders:
1529
+ description: Boolean flag to indicate whether this folder has child folders
1530
+ type: boolean
1531
+ required: false # TODO hand rolled --> see: W-9965762
1532
+ isFolder:
1533
+ description: Boolean flag to indicate whether this folder item is a folder
1534
+ type: boolean
1535
+ isPublished:
1536
+ description: Boolean flag to indicate whether this folder item is published
1537
+ type: boolean
1538
+ required: false # TODO hand rolled --> see: W-9965762
1539
+ language:
1540
+ description: Language summary of the ManagedContentVariant
1541
+ type: ManagedContentLanguageSummaryRepresentation
1542
+ required: false # TODO hand rolled --> see: W-9965762
1543
+ lastModifiedBy:
1544
+ description: The User ID for the user which last modified the ManagedContentVariant
1545
+ or ManagedContentSpaceFolder
1546
+ type: string
1547
+ lastModifiedByName:
1548
+ description: The User Name for the user which last modified the ManagedContentVariant
1549
+ or ManagedContentSpaceFolder
1550
+ type: string
1551
+ lastModifiedDate:
1552
+ description: The date when the ManagedContentVariant or ManagedContentSpaceFolder
1553
+ was last modified
1554
+ type: string
1555
+ managedContentOrFolderId:
1556
+ description: The id of the folder item - ManagedContent or ManagedContentSpaceFolder
1557
+ type: string
1558
+ managedContentVariantId:
1559
+ description: Latest Managed Content Variant Id of the folder item is ManagedContent
1560
+ type: string
1561
+ required: false # TODO hand rolled --> see: W-9965762
1562
+ mimeType:
1563
+ description: The mimetype for the content
1564
+ type: string
1565
+ status:
1566
+ description: Status of the ManagedContentVariant
1567
+ type: string
1568
+ required: false # TODO hand rolled --> see: W-9965762
1569
+ title:
1570
+ description: Title of the ManagedContent/ManagedContentSpaceFolder
1571
+ type: string
1572
+ ManagedContentSpaceFolderRepresentation:
1573
+ description: Base Representation of a CMS Folder i.e. ManagedContentSpaceFolder
1574
+ type: AbstractMCSFolderRepresentation
1575
+ properties: {}
1576
+ ManagedContentSpaceInputRepresentation:
1577
+ description: The input representation for a Managed Content Space
1578
+ type: object
1579
+ properties:
1580
+ channels:
1581
+ description: List of CMS Channels to be associated with the Managed Content
1582
+ Space
1583
+ type: array
1584
+ items:
1585
+ type: string
1586
+ collaborators:
1587
+ description: List of contributors to be associated with the Managed Content
1588
+ Space
1589
+ type: array
1590
+ items:
1591
+ type: object
1592
+ defaultLanguage:
1593
+ description: Default Language of the Managed Content Space
1594
+ type: string
1595
+ description:
1596
+ description: Description of the Managed Content Space
1597
+ type: string
1598
+ isSpaceV2:
1599
+ description: Boolean flag depicting space as 2.0 if set true
1600
+ type: boolean
1601
+ isUndeletable:
1602
+ description: Boolean flag depicting space as undeletable if set true
1603
+ type: boolean
1604
+ name:
1605
+ description: Name of the Managed Content Space
1606
+ type: string
1607
+ supportedLanguages:
1608
+ description: List of languages supported by the Managed Content Space
1609
+ type: array
1610
+ items:
1611
+ type: string
1612
+ ManagedContentSpaceMemberCollectionRepresentation:
1613
+ description: Collection representation of the members in a content space
1614
+ type: object
1615
+ properties:
1616
+ members:
1617
+ description: List of the members in the content space
1618
+ type: array
1619
+ items:
1620
+ type: ManagedContentSpaceMemberRepresentation
1621
+ ManagedContentSpaceMemberInputRepresentation:
1622
+ description: Input representation of a content space member
1623
+ type: object
1624
+ properties:
1625
+ memberId:
1626
+ description: The ID of the user/group to assign the role in the content space
1627
+ type: string
1628
+ roleId:
1629
+ description: The ID of the role to assign the user as, in the content space
1630
+ type: string
1631
+ ManagedContentSpaceMemberPermissionsRepresentation:
1632
+ description: Representation of permissions of a member in a content space
1633
+ type: object
1634
+ properties:
1635
+ permissions:
1636
+ description: A map of permissions for a member grouped by different scopes
1637
+ and consequently spaceContentTypes
1638
+ type: object
1639
+ properties:
1640
+ //:
1641
+ type: object
1642
+ properties:
1643
+ //:
1644
+ type: ManagedContentSpacePermissionRepresentation
1645
+ ManagedContentSpaceMemberRepresentation:
1646
+ description: Representation of a ManagedContentSpaceMember
1647
+ type: object
1648
+ properties:
1649
+ id:
1650
+ description: The id of managedContentSpaceMember entity object
1651
+ type: string
1652
+ memberId:
1653
+ description: The user / group id
1654
+ type: string
1655
+ role:
1656
+ description: The role associated with the member
1657
+ type: ManagedContentSpaceRoleRepresentation
1658
+ ManagedContentSpacePermissionRepresentation:
1659
+ description: Representation of a permission bit vector based on a scopeType or
1660
+ contentTypeIdOrEnum
1661
+ type: object
1662
+ properties:
1663
+ canCreate:
1664
+ description: Does the member have create access for the scopeType and spaceContentType
1665
+ type: boolean
1666
+ canDelete:
1667
+ description: Does the member have delete access for the scopeType and spaceContentType
1668
+ type: boolean
1669
+ canManage:
1670
+ description: Does the member have manage access for the scopeType and spaceContentType
1671
+ type: boolean
1672
+ canPreview:
1673
+ description: Does the member have manage access for the scopeType and spaceContentType
1674
+ type: boolean
1675
+ canPublish:
1676
+ description: Does the member have publish/unpublish access for the scopeType
1677
+ and spaceContentType
1678
+ type: boolean
1679
+ canRead:
1680
+ description: Does the member have read access for the scopeType and spaceContentType
1681
+ type: boolean
1682
+ canSchedule:
1683
+ description: Does the member have schedule access for the scopeType and spaceContentType
1684
+ type: boolean
1685
+ canTranslate:
1686
+ description: Does the member have translate access for the scopeType and spaceContentType
1687
+ type: boolean
1688
+ canUpdate:
1689
+ description: Does the member have update access for the scopeType and spaceContentType
1690
+ type: boolean
1691
+ ManagedContentSpaceRepresentation:
1692
+ description: Details of a Managed Content Space
1693
+ type: object
1694
+ properties:
1695
+ createdBy:
1696
+ description: User-Id of the creator of the Managed Content Space
1697
+ type: string
1698
+ createdDate:
1699
+ description: Date of creation of the Managed Content Space
1700
+ type: string
1701
+ defaultLanguage:
1702
+ description: Default Language of the Managed Content Space
1703
+ type: string
1704
+ description:
1705
+ description: Description of the Managed Content Space
1706
+ type: string
1707
+ id:
1708
+ description: Id of the Managed Content Space
1709
+ type: string
1710
+ isSpaceV2:
1711
+ description: Boolean flag of space v2
1712
+ type: boolean
1713
+ required: false # TODO handrolled W-9314597
1714
+ lastModifiedBy:
1715
+ description: User-Id of the user who last modified the Managed Content Space
1716
+ type: string
1717
+ lastModifiedDate:
1718
+ description: Date on which the Managed Content Space was last modified
1719
+ type: string
1720
+ name:
1721
+ description: Name of the Managed Content Space
1722
+ type: string
1723
+ rootFolderId:
1724
+ description: Root Folder Id of the Managed Content Space
1725
+ type: string
1726
+ supportedLanguages:
1727
+ description: Set of supported languages in the Managed Content Space
1728
+ type: array
1729
+ items:
1730
+ type: string
1731
+ required: false # TODO handrolled W-9314597
1732
+ ManagedContentSpaceRoleCollectionRepresentation:
1733
+ description: Collection representation of the roles in a content space
1734
+ type: object
1735
+ properties:
1736
+ roles:
1737
+ description: List of the roles in the content space
1738
+ type: array
1739
+ items:
1740
+ type: ManagedContentSpaceRoleRepresentation
1741
+ ManagedContentSpaceRoleRepresentation:
1742
+ description: Representation of a ManagedContentSpaceRole
1743
+ type: object
1744
+ properties:
1745
+ description:
1746
+ description: The role description
1747
+ type: string
1748
+ id:
1749
+ description: The role ID
1750
+ type: string
1751
+ name:
1752
+ description: The role name
1753
+ type: string
1754
+ ManagedContentSpaceSummaryRepresentation:
1755
+ description: Information about a managed content space.
1756
+ type: object
1757
+ properties:
1758
+ id:
1759
+ description: Id of the managed content space.
1760
+ type: string
1761
+ resourceUrl:
1762
+ description: Connect API resource url to ge more information about managed
1763
+ content space.
1764
+ type: string
1765
+ ManagedContentTextNodeValueRepresentation:
1766
+ description: Information about a managed content node of type text.
1767
+ type: ManagedContentNodeValueRepresentation
1768
+ properties:
1769
+ value:
1770
+ description: The text value of the managed content node.
1771
+ type: string
1772
+ ManagedContentTranslationRepresentation:
1773
+ description: Information about a managed content translation job
1774
+ type: object
1775
+ properties:
1776
+ createdBy:
1777
+ description: The user id who created the managed content translation job
1778
+ type: string
1779
+ createdDate:
1780
+ description: The created date of the managed content translation job
1781
+ type: string
1782
+ errorBodyUrl:
1783
+ description: The URL to get the error content body of a managed content translation
1784
+ job
1785
+ type: string
1786
+ id:
1787
+ description: The id of a managed content translation job
1788
+ type: string
1789
+ inputBodyUrl:
1790
+ description: The URL to get the input content body of a managed content translation
1791
+ job
1792
+ type: string
1793
+ jobType:
1794
+ description: The type of a managed content translation job
1795
+ type: string
1796
+ enum:
1797
+ - Export
1798
+ - Import
1799
+ lastModifiedBy:
1800
+ description: The last user id who has modified the managed content translation
1801
+ job
1802
+ type: string
1803
+ lastModifiedDate:
1804
+ description: The last time the managed content translation job has been modified
1805
+ type: string
1806
+ lastStatusUpdateDate:
1807
+ description: The last status update date of a managed content translation
1808
+ job
1809
+ type: string
1810
+ name:
1811
+ description: The name of a managed content translation job
1812
+ type: string
1813
+ outputBodyUrl:
1814
+ description: The URL to get the output content body of a managed content translation
1815
+ job
1816
+ type: string
1817
+ startDate:
1818
+ description: The start date of a managed content translation job
1819
+ type: string
1820
+ status:
1821
+ description: The status of a managed content translation job
1822
+ type: string
1823
+ enum:
1824
+ - Completed
1825
+ - Created
1826
+ - Failed
1827
+ - Pending
1828
+ - Processing
1829
+ ManagedContentTranslationRequestInputRep:
1830
+ description: Input representation of a translation request
1831
+ type: object
1832
+ properties:
1833
+ contentBodyId:
1834
+ description: Indicates the content body id of the translation
1835
+ type: string
1836
+ managedContentSpaceId:
1837
+ description: Managed Content Space Id
1838
+ type: string
1839
+ name:
1840
+ description: Indicates the name of the translation
1841
+ type: string
1842
+ type:
1843
+ description: Indicates the type of the translation
1844
+ type: string
1845
+ enum:
1846
+ - Export
1847
+ - Import
1848
+ ManagedContentTranslationV2Representation:
1849
+ description: Information about a managed content translation job
1850
+ type: object
1851
+ properties:
1852
+ createdBy:
1853
+ description: The user id who created the managed content translation job
1854
+ type: string
1855
+ createdDate:
1856
+ description: The created date of the managed content translation job
1857
+ type: string
1858
+ errorBodyUrl:
1859
+ description: The URL to get the error content body of a managed content translation
1860
+ job
1861
+ type: string | nil
1862
+ id:
1863
+ description: The id of a managed content translation job
1864
+ type: string
1865
+ inputBodyUrl:
1866
+ description: The URL to get the input content body of a managed content translation
1867
+ job
1868
+ type: string | nil
1869
+ jobType:
1870
+ description: The type of a managed content translation job
1871
+ type: string
1872
+ enum:
1873
+ - Export
1874
+ - Import
1875
+ lastModifiedBy:
1876
+ description: The last user id who has modified the managed content translation
1877
+ job
1878
+ type: string
1879
+ lastModifiedDate:
1880
+ description: The last time the managed content translation job has been modified
1881
+ type: string
1882
+ lastStatusUpdateDate:
1883
+ description: The last status update date of a managed content translation
1884
+ job
1885
+ type: string
1886
+ name:
1887
+ description: The name of a managed content translation job
1888
+ type: string
1889
+ outputBodyUrl:
1890
+ description: The URL to get the output content body of a managed content translation
1891
+ job
1892
+ type: string | nil
1893
+ startDate:
1894
+ description: The start date of a managed content translation job
1895
+ type: string | nil
1896
+ status:
1897
+ description: The status of a managed content translation job
1898
+ type: string
1899
+ enum:
1900
+ - Completed
1901
+ - Created
1902
+ - Failed
1903
+ - Pending
1904
+ - Processing
1905
+ ManagedContentTranslationV2RequestInputRep:
1906
+ description: Input representation of a translation V2 request
1907
+ type: object
1908
+ properties:
1909
+ folderIds:
1910
+ description: Collection of managed Content folder Ids
1911
+ type: array
1912
+ items:
1913
+ type: string
1914
+ managedContentBodyId:
1915
+ description: Indicates the managed content body id of the translation
1916
+ type: string
1917
+ managedContentVariantIds:
1918
+ description: Collection of managedContentVariantIds Ids
1919
+ type: array
1920
+ items:
1921
+ type: string
1922
+ name:
1923
+ description: Indicates the name of the translation
1924
+ type: string
1925
+ parentFolderId:
1926
+ description: Parent FolderId of Managed Content Export data
1927
+ type: string
1928
+ sourceLanguage:
1929
+ description: Indicates the source language for the authoring space
1930
+ type: string
1931
+ targetLanguages:
1932
+ description: Indicates the target languages for the export action
1933
+ type: array
1934
+ items:
1935
+ type: string
1936
+ type:
1937
+ description: Indicates the type of the translation
1938
+ type: string
1939
+ enum:
1940
+ - Export
1941
+ - Import
1942
+ ManagedContentTranslationV2RequestInputWrapperRep:
1943
+ description: Wrapper for Input required for translation V2 job
1944
+ type: object
1945
+ properties:
1946
+ translationV2Request:
1947
+ type: ManagedContentTranslationV2RequestInputRep
1948
+ ManagedContentTypeRepresentation:
1949
+ description: Information about a managed content type.
1950
+ type: object
1951
+ properties:
1952
+ label:
1953
+ description: The label of the managed content type..
1954
+ type: string
1955
+ name:
1956
+ description: The developer name of the managed content type.
1957
+ type: string
1958
+ nodeTypes:
1959
+ description: The collection of node types in this managed content type..
1960
+ type: object
1961
+ properties:
1962
+ //:
1963
+ type: ManagedContentNodeTypeRepresentation
1964
+ ManagedContentTypeSchemaRepresentation:
1965
+ description: Representation of the ManagedContentType based on schema and associated
1966
+ views.
1967
+ type: object
1968
+ properties:
1969
+ description:
1970
+ description: Text description for the ManagedContentType
1971
+ type: string
1972
+ developerName:
1973
+ description: Developer Name of the ManagedContentType
1974
+ type: string
1975
+ label:
1976
+ description: Display name of the ManagedContentType
1977
+ type: string
1978
+ namespacePrefix:
1979
+ description: Namespace prefix for the ManagedContentType
1980
+ type: string
1981
+ schema:
1982
+ description: JSON Schema representation of the ManagedContentType
1983
+ type: object
1984
+ properties:
1985
+ //:
1986
+ type: object
1987
+ views:
1988
+ description: Views Representing the ManagedContentType
1989
+ type: array
1990
+ items:
1991
+ type: ManagedContentTypeViewRepresentation
1992
+ ManagedContentTypeSearchableCollectionRepresentation:
1993
+ description: Collection of Content Type Search Status
1994
+ type: object
1995
+ properties:
1996
+ currentPageUrl:
1997
+ description: URL to the current page of Manage Content Type Search Status
1998
+ records. The default is 25 managed content channels per page.
1999
+ type: string
2000
+ items:
2001
+ description: Manage Content Type Searchable records corresponding to the current
2002
+ page
2003
+ type: array
2004
+ items:
2005
+ type: ManagedContentTypeSearchableRepresentation
2006
+ nextPageUrl:
2007
+ description: URL to the next page of Manage Content Type Search Status records.
2008
+ The default is 25 managed content channels per page.
2009
+ type: string
2010
+ totalItems:
2011
+ description: Total count of Manage Content Type Search Status records across
2012
+ all pages
2013
+ type: integer
2014
+ ManagedContentTypeSearchableInputRepresentation:
2015
+ description: The input representation for a content type search status
2016
+ type: object
2017
+ properties:
2018
+ isSearchable:
2019
+ description: Searchable status of the Content Type
2020
+ type: boolean
2021
+ name:
2022
+ description: Name of the Content Type
2023
+ type: string
2024
+ ManagedContentTypeSearchableRepresentation:
2025
+ description: Details of a Managed Content Type Search Status
2026
+ type: object
2027
+ properties:
2028
+ id:
2029
+ description: Id of the Managed Content Type
2030
+ type: string
2031
+ isSearchable:
2032
+ description: Is the contentType searchable
2033
+ type: boolean
2034
+ label:
2035
+ description: Master label of the Managed Content Type
2036
+ type: string
2037
+ name:
2038
+ description: Developer Name of the Managed Content Type
2039
+ type: string
2040
+ ManagedContentTypeSummaryRepresentation:
2041
+ description: Information about a managed content type.
2042
+ type: object
2043
+ properties:
2044
+ fullyQualifiedName:
2045
+ description: fully qualified name of a managed content type.
2046
+ type: string
2047
+ name:
2048
+ description: name of a managed content type.
2049
+ type: string
2050
+ required: false # TODO hand rolled. W-8253396
2051
+ ManagedContentTypeViewRepresentation:
2052
+ description: Representation of managed content type view list
2053
+ type: object
2054
+ properties:
2055
+ view:
2056
+ description: View associated with the schema
2057
+ type: object
2058
+ properties:
2059
+ //:
2060
+ type: object
2061
+ viewMode:
2062
+ description: View Mode of current view.
2063
+ type: string
2064
+ enum:
2065
+ - Edit
2066
+ - View
2067
+ viewType:
2068
+ description: View type of current view.
2069
+ type: string
2070
+ enum:
2071
+ - LightningView
2072
+ ManagedContentUnpublishInputWrapperRepresentation: # TODO Hand-rolled W-9800110
2073
+ description: Wrapper for Input required for unpublish managed content or variants
2074
+ type: object
2075
+ properties:
2076
+ unpublishInput:
2077
+ type: ManagedContentUnpublishInputRepresentation
2078
+ ManagedContentUnpublishInputRepresentation:
2079
+ description: Input required for unpublishing content
2080
+ type: object
2081
+ properties:
2082
+ contentIds:
2083
+ description: '[Optional] The contents to unpublish. Either contentIds or variantIds
2084
+ are required.'
2085
+ type: array
2086
+ required: false # TODO Hand-rolled W-11613845
2087
+ items:
2088
+ type: string
2089
+ description:
2090
+ description: Description for unpublish Action.
2091
+ type: string
2092
+ required: false # TODO Hand-rolled W-11613845
2093
+ variantIds:
2094
+ description: '[Optional] The variants to unpublish. Either contentIds or variantIds
2095
+ are required.'
2096
+ type: array
2097
+ required: false # TODO Hand-rolled W-11613845
2098
+ items:
2099
+ type: string
2100
+ ManagedContentUnpublishOutputRepresentation:
2101
+ description: Information about a Unpublished action
2102
+ type: object
2103
+ properties:
2104
+ deploymentId:
2105
+ description: ManagedContentDeployment Entity Id
2106
+ type: string
2107
+ description:
2108
+ description: Provided description.
2109
+ type: string | nil
2110
+ unpublishDate:
2111
+ description: Unpublish Date
2112
+ type: string | nil
2113
+ ManagedContentUserSummaryRepresentation:
2114
+ description: Information about a user who created/modified content.
2115
+ type: object
2116
+ properties:
2117
+ id:
2118
+ description: The id of the user.
2119
+ type: string
2120
+ name:
2121
+ description: The name of the user.
2122
+ type: string
2123
+ required: false # TODO hand rolled. W-8253396
2124
+ resourceUrl:
2125
+ description: The connect endpoint resourceUrl of the user to get more information
2126
+ about the user.
2127
+ type: string
2128
+ ManagedContentV2JobRepresentation:
2129
+ description: Information about a managed content import/export job
2130
+ type: object
2131
+ properties:
2132
+ createdBy:
2133
+ description: The user id who created the managed content job
2134
+ type: string
2135
+ createdDate:
2136
+ description: The created date of the managed content job
2137
+ type: string
2138
+ errorBodyUrl:
2139
+ description: The URL to get the error content body of a managed content job
2140
+ type: string | nil
2141
+ id:
2142
+ description: The id of a managed content job
2143
+ type: string
2144
+ inputBodyUrl:
2145
+ description: The URL to get the input content body of a managed content job
2146
+ type: string | nil
2147
+ jobType:
2148
+ description: The type of a managed content job
2149
+ type: string
2150
+ enum:
2151
+ - Export
2152
+ - Import
2153
+ lastModifiedBy:
2154
+ description: The last user id who has modified the managed content job
2155
+ type: string
2156
+ lastModifiedDate:
2157
+ description: The last time the managed content job has been modified
2158
+ type: string
2159
+ lastStatusUpdateDate:
2160
+ description: The last status update date of a managed content job
2161
+ type: string
2162
+ name:
2163
+ description: The name of a managed content job
2164
+ type: string
2165
+ outputBodyUrl:
2166
+ description: The URL to get the output content body of a managed content job
2167
+ type: string | nil
2168
+ startDate:
2169
+ description: The start date of a managed content job
2170
+ type: string | nil
2171
+ status:
2172
+ description: The status of a managed content job
2173
+ type: string
2174
+ enum:
2175
+ - Completed
2176
+ - CompletedWithError
2177
+ - Created
2178
+ - Failed
2179
+ - Pending
2180
+ - Processing
2181
+ ManagedContentExportContentV2JobRequestInputRepresentation:
2182
+ description: Input representation for creating a ManagedContent export job 2.0
2183
+ type: object
2184
+ properties:
2185
+ folderIds:
2186
+ description: Collection of managed Content folder Ids
2187
+ type: array
2188
+ items:
2189
+ type: string
2190
+ includeReferenceContent:
2191
+ description: The indicator to export the referenced content
2192
+ type: boolean
2193
+ includeTranslations:
2194
+ description: The indicator to export the referenced content
2195
+ type: boolean
2196
+ managedContentIds:
2197
+ description: Collection of managed Content Ids
2198
+ type: array
2199
+ items:
2200
+ type: string
2201
+ name:
2202
+ description: Managed Content Export Job Name
2203
+ type: string
2204
+ ManagedContentExportContentV2JobRequestInputWrapperRep:
2205
+ description: Wrapper for Input required for export V2 job
2206
+ type: object
2207
+ properties:
2208
+ managedContentV2JobRequest:
2209
+ type: ManagedContentExportContentV2JobRequestInputRepresentation
2210
+ ManagedContentV2JobRequestInputRepresentation:
2211
+ description: Input representation for creating a ManagedContent import job
2212
+ type: object
2213
+ properties:
2214
+ autoPublish:
2215
+ description: Auto publish the data after import if that operation is permitted
2216
+ type: boolean
2217
+ managedContentBodyId:
2218
+ description: ManagedContentBody Id of Managed Content Import data
2219
+ type: string
2220
+ name:
2221
+ description: Managed Content Job Name
2222
+ type: string
2223
+ ManagedContentImportV2JobRequestInputWrapperRep:
2224
+ description: Wrapper for Input required for import V2 job
2225
+ type: object
2226
+ properties:
2227
+ managedContentV2JobRequest:
2228
+ type: ManagedContentV2JobRequestInputRepresentation
2229
+ ManagedContentVariantInputWrapperRepresentation: # TODO Hand-rolled W-8334626
2230
+ description: wrapper for Input required for creating a variant
2231
+ type: object
2232
+ properties:
2233
+ managedContentVariantInputParam:
2234
+ type: ManagedContentVariantInputRepresentation
2235
+ ManagedContentVariantInputRepresentation:
2236
+ description: Input representation for a managed variant.
2237
+ type: object
2238
+ properties:
2239
+ contentBody:
2240
+ description: The body of the managed content.
2241
+ type: object
2242
+ properties:
2243
+ //:
2244
+ type: any # TODO hand rolled. TD-0100382
2245
+ language:
2246
+ description: The language of the variant
2247
+ type: string
2248
+ managedContentKeyOrId:
2249
+ description: The managed content key or ID which is the content associated
2250
+ to the variant to be created
2251
+ type: string
2252
+ title:
2253
+ description: The title of the managed content variant
2254
+ type: string
2255
+ required: false # TODO handrolled W-9314597
2256
+ urlName:
2257
+ description: URL-friendly identifier of the content within the org.
2258
+ type: string
2259
+ required: false # TODO handrolled W-9314597
2260
+ ManagedContentVariantRepresentation:
2261
+ description: Information about a managed content variant in authoring space.
2262
+ type: object
2263
+ properties:
2264
+ contentBody:
2265
+ description: Body contains raw fields defined in the managed content type
2266
+ schema of this managed content variant.
2267
+ type: object
2268
+ properties:
2269
+ //:
2270
+ type: any # TODO hand rolled. TD-0100382
2271
+ contentKey:
2272
+ description: Globally unique identifier of a managed content and doesn't change
2273
+ when managed content is moved between production and sandbox environments.
2274
+ type: string
2275
+ contentSpace:
2276
+ description: The content space of the managed content.
2277
+ type: ManagedContentSpaceSummaryRepresentation
2278
+ contentType:
2279
+ description: The type of the managed content.
2280
+ type: ManagedContentTypeSummaryRepresentation
2281
+ createdBy:
2282
+ description: The user who created the managed content variant.
2283
+ type: ManagedContentUserSummaryRepresentation
2284
+ createdDate:
2285
+ description: The created date of the managed content variant.
2286
+ type: string
2287
+ folder:
2288
+ description: The content folder of the managed content.
2289
+ type: ManagedContentFolderSummaryRepresentation
2290
+ isPublished:
2291
+ description: Is managed content variant published to any channel.
2292
+ type: boolean
2293
+ language:
2294
+ description: The language of the managed content.
2295
+ type: string
2296
+ lastModifiedBy:
2297
+ description: The last user who has modified the managed content variant.
2298
+ type: ManagedContentUserSummaryRepresentation
2299
+ lastModifiedDate:
2300
+ description: The last time the managed content variant has been modified.
2301
+ type: string
2302
+ managedContentId:
2303
+ description: Id of the managed content in authoring space.
2304
+ type: string
2305
+ managedContentVariantId:
2306
+ description: The managed content variant in the authoring space.
2307
+ type: string
2308
+ managedContentVersionId:
2309
+ description: Version id of the managed content version.
2310
+ type: string
2311
+ status:
2312
+ description: Status of managed content variant.
2313
+ type: ManagedContentVariantStatusRepresentation
2314
+ title:
2315
+ description: The title of the managed content.
2316
+ type: string
2317
+ urlName:
2318
+ description: The content url name of the managed content.
2319
+ type: string
2320
+ ManagedContentVariantUpdateInputWrapperRepresentation: # TODO Hand-rolled W-8334626
2321
+ description: wrapper for Input required for replacing variant
2322
+ type: object
2323
+ properties:
2324
+ ManagedContentVariantInputParam:
2325
+ type: ManagedContentVariantUpdateInputRepresentation
2326
+ ManagedContentVariantStatusRepresentation:
2327
+ description: Information about a managed content variant's status in authoring
2328
+ space.
2329
+ type: object
2330
+ properties:
2331
+ label:
2332
+ description: Localized label for status.
2333
+ type: string
2334
+ status:
2335
+ description: Status of managed content variant.
2336
+ type: string
2337
+ enum:
2338
+ - Draft
2339
+ - Published
2340
+ - Revised
2341
+ ManagedContentVariantUpdateInputRepresentation:
2342
+ description: Input representation of a managed content variant for PUT request
2343
+ type: object
2344
+ properties:
2345
+ contentBody:
2346
+ description: The body of the managed content variant
2347
+ type: object
2348
+ properties:
2349
+ //:
2350
+ type: any # TODO hand rolled. TD-0100382
2351
+ title:
2352
+ description: The title of the managed content variant
2353
+ type: string
2354
+ urlName:
2355
+ description: URL-friendly identifier of the content within the org.
2356
+ type: string
2357
+ ManagedContentVariantV1InputRep:
2358
+ description: Input representation of a managed content variant request
2359
+ type: object
2360
+ properties:
2361
+ body:
2362
+ description: Indicates the body of a variation
2363
+ type: object
2364
+ language:
2365
+ description: Indicates the language of a variation
2366
+ type: string
2367
+ managedContentVersionId:
2368
+ description: Managed Content Version Id
2369
+ type: string
2370
+ name:
2371
+ description: Indicates the name of a variation
2372
+ type: string
2373
+ parentId:
2374
+ description: Indicates the parent id of a variation
2375
+ type: string
2376
+ type:
2377
+ description: Indicates the type of the ManagedContentVariant
2378
+ type: string
2379
+ enum:
2380
+ - Translation
2381
+ - Variation
2382
+ urlName:
2383
+ description: Indicates the url name of a variation
2384
+ type: string
2385
+ ManagedContentVariantV1Representation:
2386
+ description: Information about a managed content variant
2387
+ type: object
2388
+ properties:
2389
+ body:
2390
+ description: The body of a managed content variant
2391
+ type: string
2392
+ id:
2393
+ description: The id of a managed content variant
2394
+ type: string
2395
+ language:
2396
+ description: The language of a managed content variant
2397
+ type: string
2398
+ managedContentVersionId:
2399
+ description: The id of a managed content version
2400
+ type: string
2401
+ name:
2402
+ description: The name of a managed content variant
2403
+ type: string
2404
+ parentId:
2405
+ description: The id of a parent
2406
+ type: string
2407
+ urlName:
2408
+ description: The url name of a managed content variant
2409
+ type: string
2410
+ variantType:
2411
+ description: The variant of a managed content variant
2412
+ type: string
2413
+ enum:
2414
+ - Translation
2415
+ - Variation
2416
+ ManagedContentVariantVersionCollectionRepresentation:
2417
+ description: Collection Representation of paginated published versions for given variantId
2418
+ type: object
2419
+ properties:
2420
+ currentPageUrl:
2421
+ description: The URL to the current page
2422
+ type: string
2423
+ managedContentVariantId:
2424
+ description: The variant Id of fetched record.
2425
+ type: string
2426
+ nextPageUrl:
2427
+ description: The URL to the next page, null if there isn't the next page
2428
+ type: string
2429
+ required: false
2430
+ versions:
2431
+ description: List of versions containing status, createdBy, createdDate and
2432
+ version number of variant.
2433
+ type: array
2434
+ items:
2435
+ type: ManagedContentVariantVersionRepresentation
2436
+ ManagedContentVariantVersionRepresentation:
2437
+ description: Representation of paginated published version for given variantId
2438
+ type: object
2439
+ properties:
2440
+ createdBy:
2441
+ description: User who created the current version.
2442
+ type: ManagedContentUserSummaryRepresentation
2443
+ createdDate:
2444
+ description: Date on which version was created.
2445
+ type: string
2446
+ lastModifiedBy:
2447
+ description: User who last modified the version.
2448
+ type: ManagedContentUserSummaryRepresentation
2449
+ lastModifiedDate:
2450
+ description: Date on which version was last Modified.
2451
+ type: string
2452
+ resourceUrl:
2453
+ description: Resource URL of current version.
2454
+ type: string
2455
+ status:
2456
+ description: The status of the managed content variant version - published, draft, revised.
2457
+ type: ManagedContentVariantStatusRepresentation
2458
+ title:
2459
+ description: Title of current version.
2460
+ type: string
2461
+ versionNumber:
2462
+ description: The version number of variant.
2463
+ type: string
2464
+ ManagedContentVersionCollectionRepresentation:
2465
+ description: Collection of managed content versions.
2466
+ type: object
2467
+ properties:
2468
+ currentPageUrl:
2469
+ description: URL to the current page of managed content versions. The default
2470
+ is 25 managed content versions per page.
2471
+ type: string
2472
+ items:
2473
+ description: Managed content versions for this page.
2474
+ type: array
2475
+ items:
2476
+ type: ManagedContentVersionRepresentation
2477
+ managedContentTypes:
2478
+ description: Managed content types for this page.
2479
+ type: object
2480
+ properties:
2481
+ //:
2482
+ type: ManagedContentTypeRepresentation
2483
+ nextPageUrl:
2484
+ description: URL to the next page of managed content versions, The default
2485
+ is 25 managed content versions per page.
2486
+ type: string
2487
+ total:
2488
+ description: Total number of versions across all pages.
2489
+ type: integer
2490
+ totalTypes:
2491
+ description: Total number of content types across all pages.
2492
+ type: integer
2493
+ ManagedContentVersionInputRep:
2494
+ description: Input representation for a managed content
2495
+ type: object
2496
+ properties:
2497
+ associations:
2498
+ description: 'Input Representation for associations for managed content. Describes
2499
+ how a ManagedContent is organized. Examples are the list of topics that
2500
+ are assigned to a ManagedContent and the folders in which the ManagedContent
2501
+ is placed. '
2502
+ type: object
2503
+ body:
2504
+ description: The body of the managed content version.
2505
+ type: object
2506
+ properties:
2507
+ //:
2508
+ type: object
2509
+ managedContentId:
2510
+ description: 'Id of a managed content id. This is only required when creating
2511
+ a new version of an already existing managed content. If this is specified
2512
+ the operation will mean “create a new version of the managed content with
2513
+ id”. '
2514
+ type: string
2515
+ spaceFolderId:
2516
+ description: Id of a ManagedContentSpaceFolder in which the Content should
2517
+ be created.
2518
+ type: string
2519
+ title:
2520
+ description: The title of the managed content version.
2521
+ type: string
2522
+ type:
2523
+ description: The type of the managed content, represents a category of content
2524
+ such as News, Blog or Story. The ManagedContentType.DeveloperName of the
2525
+ active ManagedContentTypeVersion of the ManagedContentVersion. This is always
2526
+ required.
2527
+ type: string
2528
+ urlName:
2529
+ description: A string that uniquely identifies the content within the org,
2530
+ could be used in e.g. URLs.
2531
+ type: string
2532
+ ManagedContentVersionInternalCollectionRepresentation:
2533
+ description: Collection of managed content versions.
2534
+ type: object
2535
+ properties:
2536
+ items:
2537
+ description: Managed content versions for this page.
2538
+ type: array
2539
+ items:
2540
+ type: ManagedContentVersionInternalRepresentation
2541
+ total:
2542
+ description: Total number of versions accros all pages.
2543
+ type: integer
2544
+ ManagedContentVersionInternalRepresentation:
2545
+ description: Information about a managed content version.
2546
+ type: object
2547
+ properties:
2548
+ associations:
2549
+ description: The Managed Content Associations, e.g. topic associations, describing
2550
+ how this Managed Content is organized and discoverable
2551
+ type: ManagedContentAssociationsRepresentation
2552
+ authoredManagedContentId:
2553
+ description: The unique identifer of the managed content in the authoring
2554
+ space.
2555
+ type: string
2556
+ body:
2557
+ description: Get the body
2558
+ type: object
2559
+ properties:
2560
+ //:
2561
+ type: object
2562
+ contentKey:
2563
+ description: The content key
2564
+ type: string
2565
+ createdByReference:
2566
+ description: Reference to the user who created the managed content version.
2567
+ type: ReferenceRepresentation
2568
+ createdDate:
2569
+ description: Get the date when the managed content version was created.
2570
+ type: string
2571
+ id:
2572
+ description: Response record Id
2573
+ type: string
2574
+ lastUpdatedByReference:
2575
+ description: Reference to the user who updated the managed content version.
2576
+ type: ReferenceRepresentation
2577
+ managedContentId:
2578
+ description: Id of the managed content that this is a version of
2579
+ type: string
2580
+ masterLanguage:
2581
+ description: Master Language of the managed content in the authoring space.
2582
+ type: string
2583
+ publishDate:
2584
+ description: Get the date when managed content version was published.
2585
+ type: string
2586
+ status:
2587
+ description: The status of the managed content version.
2588
+ type: string
2589
+ title:
2590
+ description: Get the title of the managed content version.
2591
+ type: string
2592
+ type:
2593
+ description: The type of the managed content version.
2594
+ type: string
2595
+ typeLabel:
2596
+ description: The type label of the managed content version.
2597
+ type: string
2598
+ updatedDate:
2599
+ description: Get the date when the managed content version was updated.
2600
+ type: string
2601
+ urlName:
2602
+ description: The url of the managed content version
2603
+ type: string
2604
+ ManagedContentVersionRepresentation:
2605
+ description: Information about a managed content version.
2606
+ type: object
2607
+ properties:
2608
+ associations:
2609
+ description: The Managed Content Associations, e.g. topic associations, describing
2610
+ how this Managed Content is organized and discoverable
2611
+ type: ManagedContentAssociationsRepresentation
2612
+ contentKey:
2613
+ description: The content key
2614
+ type: string
2615
+ contentNodes:
2616
+ description: Get the content nodes
2617
+ type: object
2618
+ properties:
2619
+ //:
2620
+ type: ManagedContentNodeValueRepresentation
2621
+ contentUrlName:
2622
+ description: The content url name of the managed content version.
2623
+ type: string
2624
+ language:
2625
+ description: The language of the managed content version.
2626
+ type: string
2627
+ managedContentId:
2628
+ description: The unique identifier of the managed content in the authoring
2629
+ space.
2630
+ type: string
2631
+ publishedDate:
2632
+ description: Get the date when the managed content version was last published.
2633
+ type: string
2634
+ title:
2635
+ description: Get the title of the managed content version.
2636
+ type: string
2637
+ type:
2638
+ description: The type of the managed content version.
2639
+ type: string
2640
+ typeLabel:
2641
+ description: The type label of the managed content type.
2642
+ type: string
2643
+ unauthenticatedUrl:
2644
+ description: Unauthenticated delivery Url
2645
+ type: string
2646
+ ManagedContentVersionSiteNodeCollectionRepresentation:
2647
+ description: The managed content version node collection representation of a content
2648
+ for a site
2649
+ type: object
2650
+ properties:
2651
+ nodes:
2652
+ description: parentId of the node returned
2653
+ type: array
2654
+ items:
2655
+ type: ManagedContentVersionSiteNodeRepresentation
2656
+ ManagedContentVersionSiteNodeRepresentation:
2657
+ description: The managed content version node representation of a content for
2658
+ a site
2659
+ type: object
2660
+ properties:
2661
+ contentKey:
2662
+ description: Content key of a Managed Content
2663
+ type: string
2664
+ id:
2665
+ description: id of the node returned
2666
+ type: string
2667
+ managedContentVersionId:
2668
+ description: Managed Content Version id
2669
+ type: string
2670
+ nodeBody:
2671
+ description: Node body
2672
+ type: string
2673
+ parentId:
2674
+ description: parentId of the node returned
2675
+ type: string
2676
+ ManagedContentVersionV2CollectionInputRepresentation:
2677
+ description: Input representation for collection of managed content version
2678
+ type: object
2679
+ properties:
2680
+ managedContentVersions:
2681
+ description: List of IDs of the ManagedContentVersion that need to be bulk
2682
+ inserted.
2683
+ type: array
2684
+ items:
2685
+ type: object
2686
+ ManagedContentVersionV2CollectionRepresentation:
2687
+ description: Collection of json based managed content versions.
2688
+ type: object
2689
+ properties:
2690
+ total:
2691
+ description: Total number of versions across all pages.
2692
+ type: integer
2693
+ versions:
2694
+ description: Managed content versions for this page.
2695
+ type: array
2696
+ items:
2697
+ type: ManagedContentVersionV2Representation
2698
+ ManagedContentVersionV2InputRepresentation:
2699
+ description: Input representation for a managed content version
2700
+ type: object
2701
+ properties:
2702
+ body:
2703
+ description: The body of the managed content version.
2704
+ type: object
2705
+ properties:
2706
+ //:
2707
+ type: object
2708
+ contentKey:
2709
+ description: Content Key of a managed content id.
2710
+ type: string
2711
+ language:
2712
+ description: The language of the managed content version.
2713
+ type: string
2714
+ managedContentId:
2715
+ description: 'Id of a managed content id. This is only required when creating
2716
+ a new version of an already existing managed content. If this is specified
2717
+ the operation will mean “create a new version of the managed content with
2718
+ id”. '
2719
+ type: string
2720
+ parentIdOrKey:
2721
+ description: Content Key of Parent Managed Content
2722
+ type: string
2723
+ title:
2724
+ description: The title of the managed content version.
2725
+ type: string
2726
+ type:
2727
+ description: The type of the managed content, represents a category of content
2728
+ such as News, Blog or Story. The ManagedContentType.DeveloperName of the
2729
+ active ManagedContentTypeVersion of the ManagedContentVersion. This is always
2730
+ required.
2731
+ type: string
2732
+ urlName:
2733
+ description: A string that uniquely identifies the content within the org,
2734
+ could be used in e.g. URLs.
2735
+ type: string
2736
+ ManagedContentVersionV2Representation:
2737
+ description: Information about a managed content version.
2738
+ type: object
2739
+ properties:
2740
+ body:
2741
+ description: Get body of the managed content version.
2742
+ type: object
2743
+ properties:
2744
+ //:
2745
+ type: object
2746
+ contentKey:
2747
+ description: Content Key of the managed content.
2748
+ type: string
2749
+ createdBy:
2750
+ description: The user id who created the managed content version
2751
+ type: string
2752
+ createdDate:
2753
+ description: The created date of the managed content version
2754
+ type: string
2755
+ id:
2756
+ description: The unique identifier of the managed content version in the authoring
2757
+ space.
2758
+ type: string
2759
+ language:
2760
+ description: The master language of the managed content version.
2761
+ type: string
2762
+ lastModifiedBy:
2763
+ description: The last user id who has modified the managed content version
2764
+ type: string
2765
+ lastModifiedDate:
2766
+ description: The last time the managed content version has been modified
2767
+ type: string
2768
+ managedContentId:
2769
+ description: The unique identifier of the managed content in the authoring
2770
+ space.
2771
+ type: string
2772
+ parentId:
2773
+ description: Parent ManagedContent Id of the managed content version.
2774
+ type: string
2775
+ renditionLanguage:
2776
+ description: The language of the managed content version.
2777
+ type: string
2778
+ status:
2779
+ description: Get status of the managed content version.
2780
+ type: string
2781
+ title:
2782
+ description: Get the title of the managed content version.
2783
+ type: string
2784
+ type:
2785
+ description: The type of the managed content version.
2786
+ type: string
2787
+ urlName:
2788
+ description: The content url name of the managed content version.
2789
+ type: string
2790
+ TopicSummaryRepresentation:
2791
+ description: A summary of a topic
2792
+ type: object
2793
+ properties:
2794
+ id:
2795
+ description: The ID of the topic
2796
+ type: string
2797
+ name:
2798
+ description: The name of the topic
2799
+ type: string
2800
+ StreamedRepresentation: # TODO hand rolled. W-9275422
2801
+ type: object
2802
+ ReferenceRepresentation: # TODO hand rolled. W-9275452
2803
+ type: object
2804
+ ManagedContentVariantSearchResultRepresentation:
2805
+ description: A keyword-based search result for a Managed Content Variant
2806
+ type: AbstractManagedContentSearchResultRepresentation
2807
+ properties:
2808
+ contentKey:
2809
+ description: The managed content key of the managed content variant.
2810
+ type: string
2811
+ contentType:
2812
+ description: The content type of the managed content variant.
2813
+ type: ManagedContentSearchResultContentTypeRepresentation
2814
+ language:
2815
+ description: The language summary of the managed content variant.
2816
+ type: ManagedContentLanguageSummaryRepresentation
2817
+ lastPublishedDate:
2818
+ description: The last time the managed content variant was published.
2819
+ type: string
2820
+ managedContentId:
2821
+ description: The ID of the managed content parent of the managed content variant.
2822
+ type: string
2823
+ mimeType:
2824
+ description: The MIME type of the managed content variant.
2825
+ type: string
2826
+ status:
2827
+ description: The status of the managed content variant.
2828
+ type: string
2829
+ enum:
2830
+ - Draft
2831
+ - Published
2832
+ - Revised
2833
+ title:
2834
+ description: The title of the managed content variant.
2835
+ type: string
2836
+ urlName:
2837
+ description: The url of the managed content variant.
2838
+ type: string
2839
+ urlValue:
2840
+ description: The url value for the managed content variant.
2841
+ type: string
2842
+ variantType:
2843
+ description: The variant type of the managed content variant.
2844
+ type: string
2845
+ enum:
2846
+ - Content
2847
+ - Translation
2848
+ - Variation
2849
+ ManagedContentVariantReferenceDetailsRepresentation:
2850
+ description: Information about referenced content variants
2851
+ type: object
2852
+ properties:
2853
+ contentKey:
2854
+ description: ContentKey of this reference Variant’s content
2855
+ type: string
2856
+ contentType:
2857
+ description: Variant content type
2858
+ type: ManagedContentTypeSummaryRepresentation
2859
+ createdBy:
2860
+ description: User created this variant
2861
+ type: ManagedContentUserSummaryRepresentation
2862
+ createdDate:
2863
+ description: Date variant got created
2864
+ type: string
2865
+ isReady:
2866
+ description: Indicates whether this Variant is ready for publish
2867
+ type: boolean
2868
+ language:
2869
+ description: Variant language
2870
+ type: ManagedContentLanguageSummaryRepresentation
2871
+ lastModifiedBy:
2872
+ description: User last modified this variant
2873
+ type: ManagedContentUserSummaryRepresentation
2874
+ lastModifiedDate:
2875
+ description: Date variant got last modified
2876
+ type: string
2877
+ managedContentId:
2878
+ description: managedContentId of this reference Variant’s content
2879
+ type: string
2880
+ managedContentVariantId:
2881
+ description: Reference Variant id
2882
+ type: string
2883
+ status:
2884
+ description: |
2885
+ Indicates variant status.
2886
+ type: ManagedContentVariantStatusRepresentation
2887
+ title:
2888
+ description: Title of the variant
2889
+ type: string
2890
+ ManagedContentVariantReferencesCollectionRepresentation:
2891
+ description: Collection of Reference variants
2892
+ type: object
2893
+ properties:
2894
+ referenceVariants:
2895
+ description: Reference variants collection
2896
+ type: object
2897
+ properties:
2898
+ //:
2899
+ type: array
2900
+ items:
2901
+ type: ManagedContentVariantReferenceDetailsRepresentation
2902
+ /cms:
2903
+ /delivery:
2904
+ /channels/{channelId}/variants:
2905
+ post:
2906
+ description: Get a list of variants published to a channel filtered by a
2907
+ variant key and list of contentIds
2908
+ responses:
2909
+ '200':
2910
+ description: Success
2911
+ body:
2912
+ application/json:
2913
+ type: MCDeliveryV2VariantCollectionRepresentation
2914
+ body:
2915
+ application/json:
2916
+ type: MCDeliveryV2VariantInputRepresentation
2917
+ #required: false # TODO hand rolled. W-9275477
2918
+ (oas-body-name): MCVariantDeliveryByContentIdAndVariantKey
2919
+ uriParameters:
2920
+ channelId:
2921
+ type: string
2922
+ required: true
2923
+ /{targetId}/collection/{collectionNameOrContentKey}:
2924
+ get:
2925
+ description: Get list of collection items.
2926
+ responses:
2927
+ '200':
2928
+ description: Success
2929
+ body:
2930
+ application/json:
2931
+ type: MContentCollectionRepresentation
2932
+ queryParameters:
2933
+ language:
2934
+ type: string
2935
+ required: false
2936
+ page:
2937
+ type: integer
2938
+ required: false
2939
+ pageSize:
2940
+ type: integer
2941
+ required: false
2942
+ uriParameters:
2943
+ collectionNameOrContentKey:
2944
+ type: string
2945
+ required: true
2946
+ targetId:
2947
+ type: string
2948
+ required: true
2949
+ /{targetId}/collection/{collectionNameOrContentKey}/metadata:
2950
+ get:
2951
+ description: Get collection metadata.
2952
+ responses:
2953
+ '200':
2954
+ description: Success
2955
+ body:
2956
+ application/json:
2957
+ type: MContentCollectionMetadataRepresentation
2958
+ queryParameters:
2959
+ language:
2960
+ type: string
2961
+ required: false
2962
+ uriParameters:
2963
+ collectionNameOrContentKey:
2964
+ type: string
2965
+ required: true
2966
+ targetId:
2967
+ type: string
2968
+ required: true
2969
+ /deployments:
2970
+ get:
2971
+ description: Get deployments Information for the given space or ManagedContentVersion
2972
+ or deploymentId
2973
+ responses:
2974
+ '200':
2975
+ description: Success
2976
+ body:
2977
+ application/json:
2978
+ type: ManagedContentDeploymentCollectionRepresentation
2979
+ queryParameters:
2980
+ contentSpaceId:
2981
+ type: string
2982
+ required: false
2983
+ deploymentId:
2984
+ type: string
2985
+ required: false
2986
+ deploymentStatus:
2987
+ type: string
2988
+ required: false
2989
+ enum:
2990
+ - Canceled
2991
+ - Created
2992
+ - Deployed
2993
+ - Error
2994
+ - Staged
2995
+ deploymentType:
2996
+ type: string
2997
+ required: false
2998
+ enum:
2999
+ - Publish
3000
+ - Unpublish
3001
+ managedContentVersionId:
3002
+ type: string
3003
+ required: false
3004
+ page:
3005
+ type: integer
3006
+ required: false
3007
+ pageSize:
3008
+ type: integer
3009
+ required: false
3010
+ post:
3011
+ description: Create a deployment to a specific channel
3012
+ responses:
3013
+ '200':
3014
+ description: Success
3015
+ body:
3016
+ application/json:
3017
+ type: ManagedContentDeploymentRepresentation
3018
+ body:
3019
+ application/json:
3020
+ type: ManagedContentDeploymentInputWrapperRepresentation # TODO Hand-rolled W-8334626
3021
+ #required: false # TODO hand rolled. W-9275477
3022
+ (oas-body-name): DeploymentInput
3023
+ /deployments/{deploymentId}:
3024
+ delete:
3025
+ description: Delete and cleanup all resources used by a deployment
3026
+ responses:
3027
+ '200':
3028
+ description: Success
3029
+ patch:
3030
+ description: Patch a deployment
3031
+ responses:
3032
+ '200':
3033
+ description: Success
3034
+ body:
3035
+ application/json:
3036
+ type: ManagedContentDeploymentRepresentation
3037
+ uriParameters:
3038
+ deploymentId:
3039
+ type: string
3040
+ required: true
3041
+ /site-author/content:
3042
+ /content-keys:
3043
+ get:
3044
+ description: Get the managed content versions, can include children and
3045
+ maked for delete versions
3046
+ responses:
3047
+ '200':
3048
+ description: Success
3049
+ body:
3050
+ application/json:
3051
+ type: MCSiteContentCollectionRepresentation
3052
+ queryParameters:
3053
+ contentKeys:
3054
+ type: array
3055
+ required: false
3056
+ items:
3057
+ type: string
3058
+ (oas-collectionFormat): csv
3059
+ includeChildren:
3060
+ type: string
3061
+ required: false
3062
+ includeMarkForDeleted:
3063
+ type: string
3064
+ required: false
3065
+ /{contentKey}:
3066
+ delete:
3067
+ description: Delete a Managed Content.
3068
+ responses:
3069
+ '200':
3070
+ description: Success
3071
+ queryParameters:
3072
+ deleteType:
3073
+ type: string
3074
+ required: false
3075
+ get:
3076
+ description: Get a managed content version, can include children
3077
+ responses:
3078
+ '200':
3079
+ description: Success
3080
+ body:
3081
+ application/json:
3082
+ type: MCSiteContentRepresentation
3083
+ queryParameters:
3084
+ includeChildren:
3085
+ type: string
3086
+ required: false
3087
+ uriParameters:
3088
+ contentKey:
3089
+ type: string
3090
+ required: true
3091
+ /node/{contentNode}:
3092
+ get:
3093
+ description: Get a managed content node for the top level content key
3094
+ responses:
3095
+ '200':
3096
+ description: Success
3097
+ body:
3098
+ application/json:
3099
+ type: ManagedContentVersionSiteNodeRepresentation
3100
+ uriParameters:
3101
+ contentKey:
3102
+ type: string
3103
+ required: true
3104
+ contentNode:
3105
+ type: string
3106
+ required: true
3107
+ /nodes:
3108
+ get:
3109
+ description: Get managed content nodes for the top level content key and
3110
+ given nodeIds
3111
+ responses:
3112
+ '200':
3113
+ description: Success
3114
+ body:
3115
+ application/json:
3116
+ type: ManagedContentVersionSiteNodeCollectionRepresentation
3117
+ queryParameters:
3118
+ contentNodes:
3119
+ type: array
3120
+ required: false
3121
+ items:
3122
+ type: string
3123
+ (oas-collectionFormat): csv
3124
+ uriParameters:
3125
+ contentKey:
3126
+ type: string
3127
+ required: true
3128
+ /site-delivery/{channelId}/contents:
3129
+ /content-keys:
3130
+ post:
3131
+ description: Get the contents published to a site by their content keys
3132
+ responses:
3133
+ '200':
3134
+ description: Success
3135
+ body:
3136
+ application/json:
3137
+ type: MCSiteContentCollectionRepresentation
3138
+ body:
3139
+ application/json:
3140
+ type: MCSiteDeliveryByContentKeysInputRepresentation
3141
+ #required: false # TODO hand rolled. W-9275477
3142
+ (oas-body-name): SiteDeliveryByContentKeys
3143
+ uriParameters:
3144
+ channelId:
3145
+ type: string
3146
+ required: true
3147
+ /content-types:
3148
+ post:
3149
+ description: Get the contents published to a site by their content types
3150
+ responses:
3151
+ '200':
3152
+ description: Success
3153
+ body:
3154
+ application/json:
3155
+ type: ManagedContentCollectionRepresentation
3156
+ body:
3157
+ application/json:
3158
+ type: MCSiteDeliveryByContentTypesInputRepresentation
3159
+ #required: false # TODO hand rolled. W-9275477
3160
+ (oas-body-name): SiteDeliveryByContentTypes
3161
+ uriParameters:
3162
+ channelId:
3163
+ type: string
3164
+ required: true
3165
+ /node-ids:
3166
+ post:
3167
+ description: Get the nodes in a content published to a site by their node
3168
+ ids
3169
+ responses:
3170
+ '200':
3171
+ description: Success
3172
+ body:
3173
+ application/json:
3174
+ type: MCSiteNodeCollectionRepresentation
3175
+ body:
3176
+ application/json:
3177
+ type: MCSiteDeliveryByNodesInputRepresentation
3178
+ #required: false # TODO hand rolled. W-9275477
3179
+ (oas-body-name): SiteDeliveryByNodeIds
3180
+ uriParameters:
3181
+ channelId:
3182
+ type: string
3183
+ required: true
3184
+ /spaces/{contentSpaceId}/preview-endpoints:
3185
+ get:
3186
+ description: Get managed content previews for the given space and contentType
3187
+ responses:
3188
+ '200':
3189
+ description: Success
3190
+ body:
3191
+ application/json:
3192
+ type: ManagedContentPreviewCollectionRepresentation
3193
+ queryParameters:
3194
+ managedContentTypeName:
3195
+ type: string
3196
+ required: false
3197
+ uriParameters:
3198
+ contentSpaceId:
3199
+ type: string
3200
+ required: true
3201
+ /connect:
3202
+ /cms:
3203
+ /channels/{channelId}/searchable-content-types:
3204
+ get:
3205
+ description: Get searchable status of managed content types in a channel.
3206
+ responses:
3207
+ '200':
3208
+ description: Success
3209
+ body:
3210
+ application/json:
3211
+ type: ManagedContentTypeSearchableCollectionRepresentation
3212
+ queryParameters:
3213
+ page:
3214
+ type: integer
3215
+ required: false
3216
+ pageSize:
3217
+ type: integer
3218
+ required: false
3219
+ patch:
3220
+ description: Update searchable status of a managed content type
3221
+ responses:
3222
+ '200':
3223
+ description: Success
3224
+ body:
3225
+ application/json:
3226
+ type: ManagedContentTypeSearchableRepresentation
3227
+ body:
3228
+ application/json:
3229
+ type: ManagedContentTypeSearchableInputRepresentation
3230
+ #required: false # TODO hand rolled. W-9275477
3231
+ (oas-body-name): contentTypeSearchInput
3232
+ uriParameters:
3233
+ channelId:
3234
+ type: string
3235
+ required: true
3236
+ /collections/{collectionKeyOrId}:
3237
+ get:
3238
+ description: Get collection Items for authoring.
3239
+ responses:
3240
+ '200':
3241
+ description: Success
3242
+ body:
3243
+ application/json:
3244
+ type: ManagedContentCollectionDetailRepresentation
3245
+ queryParameters:
3246
+ language:
3247
+ description: Language locale for the managed content collection, for
3248
+ example, en_US.
3249
+ type: string
3250
+ required: false
3251
+ version:
3252
+ description: Version number for content, for example, 2.1 (CMS 2.0).
3253
+ type: string
3254
+ required: false
3255
+ uriParameters:
3256
+ collectionKeyOrId:
3257
+ type: string
3258
+ required: true
3259
+ /content:
3260
+ get:
3261
+ description: Get ist of managed content id and its corresponding managed
3262
+ content space ids
3263
+ responses:
3264
+ '200':
3265
+ description: Success
3266
+ body:
3267
+ application/json:
3268
+ type: ManagedContentDetailCollectionRepresentation
3269
+ queryParameters:
3270
+ contentKeys:
3271
+ type: array
3272
+ required: false
3273
+ items:
3274
+ type: string
3275
+ (oas-collectionFormat): csv
3276
+ managedContentIds:
3277
+ type: array
3278
+ required: false
3279
+ items:
3280
+ type: string
3281
+ (oas-collectionFormat): csv
3282
+ /jobs:
3283
+ /export:
3284
+ post:
3285
+ description: Create a job for exporting Managed Content
3286
+ responses:
3287
+ '200':
3288
+ description: Success
3289
+ body:
3290
+ application/json:
3291
+ type: ManagedContentJobRepresentation
3292
+ body:
3293
+ application/json:
3294
+ type: ManagedContentExportContentJobRequestInputRepresentation
3295
+ #required: false # TODO hand rolled. W-9275477
3296
+ (oas-body-name): managedContentJobRequest
3297
+ /import:
3298
+ post:
3299
+ description: Create a job for importing Managed Content
3300
+ responses:
3301
+ '200':
3302
+ description: Success
3303
+ body:
3304
+ application/json:
3305
+ type: ManagedContentJobRepresentation
3306
+ body:
3307
+ application/json:
3308
+ type: ManagedContentJobRequestInputRepresentation
3309
+ #required: false # TODO hand rolled. W-9275477
3310
+ (oas-body-name): managedContentJobRequest
3311
+ /{jobId}:
3312
+ delete:
3313
+ description: Delete an instance of a ManagedContentImportExportJob.
3314
+ responses:
3315
+ '200':
3316
+ description: Success
3317
+ get:
3318
+ description: Get a specific Managed Content Job (CMS Import/Export)
3319
+ record
3320
+ responses:
3321
+ '200':
3322
+ description: Success
3323
+ body:
3324
+ application/json:
3325
+ type: ManagedContentJobRepresentation
3326
+ uriParameters:
3327
+ jobId:
3328
+ type: string
3329
+ required: true
3330
+ /spaces/{contentSpaceId}:
3331
+ /translation:
3332
+ post:
3333
+ description: Create a translation job
3334
+ responses:
3335
+ '200':
3336
+ description: Success
3337
+ body:
3338
+ application/json:
3339
+ type: ManagedContentTranslationV2Representation
3340
+ body:
3341
+ application/json:
3342
+ type: ManagedContentTranslationV2RequestInputWrapperRep
3343
+ (oas-body-name): translationV2Request
3344
+ uriParameters:
3345
+ contentSpaceId:
3346
+ type: string
3347
+ required: true
3348
+ /version:
3349
+ post:
3350
+ description: Create Managed Content Version for Json store
3351
+ responses:
3352
+ '200':
3353
+ description: Success
3354
+ body:
3355
+ application/json:
3356
+ type: ManagedContentVersionV2Representation
3357
+ body:
3358
+ application/json:
3359
+ type: ManagedContentVersionV2InputRepresentation
3360
+ #required: false # TODO hand rolled. W-9275477
3361
+ (oas-body-name): managedContentVersionV2Request
3362
+ uriParameters:
3363
+ contentSpaceId:
3364
+ type: string
3365
+ required: true
3366
+ /versions:
3367
+ post:
3368
+ description: Create Managed Content Versions for Json store
3369
+ responses:
3370
+ '200':
3371
+ description: Success
3372
+ body:
3373
+ application/json:
3374
+ type: ManagedContentVersionV2CollectionRepresentation
3375
+ body:
3376
+ application/json:
3377
+ type: ManagedContentVersionV2CollectionInputRepresentation
3378
+ #required: false # TODO hand rolled. W-9275477
3379
+ (oas-body-name): managedContentVersionV2CollectionRequest
3380
+ uriParameters:
3381
+ contentSpaceId:
3382
+ type: string
3383
+ required: true
3384
+ /variant:
3385
+ post:
3386
+ description: Create a managed content variant
3387
+ responses:
3388
+ '200':
3389
+ description: Success
3390
+ body:
3391
+ application/json:
3392
+ type: ManagedContentVariantV1Representation
3393
+ body:
3394
+ application/json:
3395
+ type: ManagedContentVariantV1InputRep
3396
+ #required: false # TODO hand rolled. W-9275477
3397
+ (oas-body-name): variantRequest
3398
+ /version/{managedContentVersionId}:
3399
+ get:
3400
+ description: Get a single managed content version
3401
+ responses:
3402
+ '200':
3403
+ description: Success
3404
+ body:
3405
+ application/json:
3406
+ type: ManagedContentVersionV2Representation
3407
+ queryParameters:
3408
+ language:
3409
+ type: string
3410
+ required: false
3411
+ variantType:
3412
+ type: string
3413
+ required: false
3414
+ patch:
3415
+ description: Patch a single managed content version
3416
+ responses:
3417
+ '200':
3418
+ description: Success
3419
+ body:
3420
+ application/json:
3421
+ type: ManagedContentVersionV2Representation
3422
+ body:
3423
+ application/json:
3424
+ type: ManagedContentVersionV2InputRepresentation
3425
+ #required: false # TODO hand rolled. W-9275477
3426
+ (oas-body-name): managedContentVersionV2Request
3427
+ put:
3428
+ description: Put a single managed content version
3429
+ responses:
3430
+ '200':
3431
+ description: Success
3432
+ body:
3433
+ application/json:
3434
+ type: ManagedContentVersionV2Representation
3435
+ body:
3436
+ application/json:
3437
+ type: ManagedContentVersionV2InputRepresentation
3438
+ #required: false # TODO hand rolled. W-9275477
3439
+ (oas-body-name): managedContentVersionV2Request
3440
+ uriParameters:
3441
+ managedContentVersionId:
3442
+ type: string
3443
+ required: true
3444
+ /content-types/{contentTypeFQN}:
3445
+ get:
3446
+ description: Gets the actual JSON Schema associated with the specified content
3447
+ type fully qualified name, after transformation using the provided filters.
3448
+ responses:
3449
+ '200':
3450
+ description: Success
3451
+ body:
3452
+ application/json:
3453
+ type: ManagedContentTypeSchemaRepresentation
3454
+ queryParameters:
3455
+ includeSchemaDefinitions:
3456
+ description: Generate Inline Schema Definitions
3457
+ type: boolean
3458
+ required: false
3459
+ viewMode:
3460
+ description: View/Edit Mode
3461
+ type: array
3462
+ required: false
3463
+ items:
3464
+ type: string
3465
+ enum:
3466
+ - Edit
3467
+ - View
3468
+ (oas-collectionFormat): csv
3469
+ uriParameters:
3470
+ contentTypeFQN:
3471
+ type: string
3472
+ required: true
3473
+ /contents:
3474
+ post:
3475
+ description: Create Managed Content for Json store
3476
+ responses:
3477
+ '200':
3478
+ description: Success
3479
+ body:
3480
+ application/json:
3481
+ type: ManagedContentDocumentRepresentation
3482
+ body:
3483
+ application/json:
3484
+ type: ManagedContentInputWrapperRepresentation
3485
+ #required: false # TODO hand rolled. W-9275477
3486
+ (oas-body-name): ManagedContentInputParam
3487
+ /publish:
3488
+ post:
3489
+ description: Publish content to specified channels
3490
+ responses:
3491
+ '200':
3492
+ description: Success
3493
+ body:
3494
+ application/json:
3495
+ type: ManagedContentPublishOutputRepresentation
3496
+ body:
3497
+ application/json:
3498
+ type: ManagedContentPublishInputWrapperRepresentation
3499
+ (oas-body-name): publishInput
3500
+ /unpublish:
3501
+ post:
3502
+ description: Unpublish content to specified channels
3503
+ responses:
3504
+ '200':
3505
+ description: Success
3506
+ body:
3507
+ application/json:
3508
+ type: ManagedContentUnpublishOutputRepresentation
3509
+ body:
3510
+ application/json:
3511
+ type: ManagedContentUnpublishInputWrapperRepresentation
3512
+ (oas-body-name): unpublishInput
3513
+ /variants:
3514
+ post:
3515
+ description: Create Managed Content Variant but not a primary variant
3516
+ responses:
3517
+ '200':
3518
+ description: Success
3519
+ body:
3520
+ application/json:
3521
+ type: ManagedContentVariantRepresentation
3522
+ body:
3523
+ application/json:
3524
+ type: ManagedContentVariantInputWrapperRepresentation
3525
+ (oas-body-name): ManagedContentVariantInputParam
3526
+ /variants/{variantId}:
3527
+ delete:
3528
+ description: Delete a managed content variant given its Id
3529
+ responses:
3530
+ '200':
3531
+ description: Success
3532
+ get:
3533
+ description: Gets a managed content variant by Id.
3534
+ responses:
3535
+ '200':
3536
+ description: Success
3537
+ body:
3538
+ application/json:
3539
+ type: ManagedContentVariantRepresentation
3540
+ put:
3541
+ description: Replace a managed content variant.
3542
+ responses:
3543
+ '200':
3544
+ description: Success
3545
+ body:
3546
+ application/json:
3547
+ type: ManagedContentVariantRepresentation
3548
+ body:
3549
+ application/json:
3550
+ type: ManagedContentVariantUpdateInputWrapperRepresentation
3551
+ #required: false # TODO hand rolled. W-9275477
3552
+ (oas-body-name): ManagedContentVariantInputParam
3553
+ uriParameters:
3554
+ variantId:
3555
+ type: string
3556
+ required: true
3557
+ /variants/{variantId}/versions:
3558
+ get:
3559
+ description: Get all the versions of a given variant.
3560
+ responses:
3561
+ '200':
3562
+ description: Success
3563
+ body:
3564
+ application/json:
3565
+ type: ManagedContentVariantVersionCollectionRepresentation
3566
+ queryParameters:
3567
+ page:
3568
+ type: integer
3569
+ required: false
3570
+ pageSize:
3571
+ type: integer
3572
+ required: false
3573
+ status:
3574
+ type: array
3575
+ required: false
3576
+ items:
3577
+ type: string
3578
+ (oas-collectionFormat): csv
3579
+ uriParameters:
3580
+ variantId:
3581
+ type: string
3582
+ required: true
3583
+ /{contentKeyOrId}:
3584
+ get:
3585
+ description: Gets existing managed content for provided version.
3586
+ responses:
3587
+ '200':
3588
+ description: Success
3589
+ body:
3590
+ application/json:
3591
+ type: ManagedContentDocumentRepresentation
3592
+ queryParameters:
3593
+ language:
3594
+ description: Language locale for the managed content, for example, en_US.
3595
+ type: string
3596
+ required: false
3597
+ version:
3598
+ description: An 18-character unique Salesforce identifier for the content (CMS 1.0) or version number for content, for example, 2.1 (CMS 2.0).
3599
+ type: string
3600
+ required: false
3601
+ uriParameters:
3602
+ contentKeyOrId:
3603
+ description: A unique identifier or ID of a content.
3604
+ type: string
3605
+ required: true
3606
+ /renditions/{renditionType}:
3607
+ get:
3608
+ description: Get a rendition of CMS content.
3609
+ responses:
3610
+ '200':
3611
+ description: Success
3612
+ body:
3613
+ application/json:
3614
+ type: ManagedContentRenditionRepresentation
3615
+ queryParameters:
3616
+ channelIdOrApiName:
3617
+ description: CMS Channel Id or API name
3618
+ type: string
3619
+ required: false
3620
+ language:
3621
+ description: Language locale for the managed content, for example, en_US.
3622
+ type: string
3623
+ required: false
3624
+ version:
3625
+ description: version number of variant, for example, '2.1'.
3626
+ type: string
3627
+ required: false
3628
+ uriParameters:
3629
+ contentKeyOrId:
3630
+ description: A unique identifier or ID of a content.
3631
+ type: string
3632
+ required: true
3633
+ renditionType:
3634
+ description: Type of rendition required.
3635
+ type: string
3636
+ required: true
3637
+ /{contentKeyOrId}/referenced-by:
3638
+ get:
3639
+ description: Get list of referencing items referenced by given contentKeyOrId
3640
+ responses:
3641
+ '200':
3642
+ description: Success
3643
+ body:
3644
+ application/json:
3645
+ type: ManagedContentReferencedByCollectionRepresentation
3646
+ queryParameters:
3647
+ includeReferenceDetails:
3648
+ type: boolean
3649
+ required: false
3650
+ page:
3651
+ type: integer
3652
+ required: false
3653
+ pageSize:
3654
+ type: integer
3655
+ required: false
3656
+ referenceType:
3657
+ type: string
3658
+ required: false
3659
+ enum:
3660
+ - Dependency
3661
+ - Link
3662
+ uriParameters:
3663
+ contentKeyOrId:
3664
+ description: A unique identifier or ID of a content.
3665
+ type: string
3666
+ required: true
3667
+ /{contentKeyOrId}/variants/references:
3668
+ get:
3669
+ description: Get variant references for publishing purpose
3670
+ responses:
3671
+ '200':
3672
+ description: Success
3673
+ body:
3674
+ application/json:
3675
+ type: ManagedContentVariantReferencesCollectionRepresentation
3676
+ queryParameters:
3677
+ variantIds:
3678
+ type: array
3679
+ required: false
3680
+ items:
3681
+ type: string
3682
+ (oas-collectionFormat): csv
3683
+ uriParameters:
3684
+ contentKeyOrId:
3685
+ description: A unique identifier or ID of a content.
3686
+ type: string
3687
+ required: true
3688
+ /deliveries/{deliveryChannelIdOrSiteId}/contents/{contentKeyOrId}:
3689
+ get:
3690
+ description: Get a single record of content published to a particular channel
3691
+ or site
3692
+ responses:
3693
+ '200':
3694
+ description: Success
3695
+ body:
3696
+ application/json:
3697
+ type: ManagedContentDocumentDeliveryRepresentation
3698
+ queryParameters:
3699
+ language:
3700
+ type: string
3701
+ required: false
3702
+ uriParameters:
3703
+ contentKeyOrId:
3704
+ type: string
3705
+ required: true
3706
+ deliveryChannelIdOrSiteId:
3707
+ type: string
3708
+ required: true
3709
+ /folders:
3710
+ post:
3711
+ description: Create a space folder
3712
+ responses:
3713
+ '200':
3714
+ description: Success
3715
+ body:
3716
+ application/json:
3717
+ type: ManagedContentSpaceFolderRepresentation
3718
+ body:
3719
+ application/json:
3720
+ type: ManagedContentSpaceFolderInputRep
3721
+ #required: false # TODO hand rolled. W-9275477
3722
+ (oas-body-name): managedContentSpaceFolderInput
3723
+ /folders/{folderId}:
3724
+ get:
3725
+ description: Get information of a folder
3726
+ responses:
3727
+ '200':
3728
+ description: Success
3729
+ body:
3730
+ application/json:
3731
+ type: ManagedContentSpaceFolderDetailRepresentation
3732
+ uriParameters:
3733
+ folderId:
3734
+ type: string
3735
+ required: true
3736
+ /folders/{folderId}/items:
3737
+ get:
3738
+ description: Get list of folder items
3739
+ responses:
3740
+ '200':
3741
+ description: Success
3742
+ body:
3743
+ application/json:
3744
+ type: ManagedContentSpaceFolderItemCollectionRepresentation
3745
+ queryParameters:
3746
+ contentType:
3747
+ type: string
3748
+ required: false
3749
+ contentTypeFilter:
3750
+ type: string
3751
+ required: false
3752
+ enum:
3753
+ - In
3754
+ - NotIn
3755
+ contentTypes:
3756
+ type: array
3757
+ required: false
3758
+ items:
3759
+ type: string
3760
+ (oas-collectionFormat): csv
3761
+ filter:
3762
+ type: string
3763
+ required: false
3764
+ enum:
3765
+ - Content
3766
+ - Folders
3767
+ page:
3768
+ type: integer
3769
+ required: false
3770
+ pageSize:
3771
+ type: integer
3772
+ required: false
3773
+ queryTerm:
3774
+ type: string
3775
+ required: false
3776
+ showPublishedOnly:
3777
+ type: boolean
3778
+ required: false
3779
+ sortBy:
3780
+ type: string
3781
+ required: false
3782
+ enum:
3783
+ - LastModified
3784
+ - Status
3785
+ - Title
3786
+ sortOrder:
3787
+ type: string
3788
+ required: false
3789
+ patch:
3790
+ description: Patch specified folder item IDs - Supporting move operation
3791
+ only
3792
+ responses:
3793
+ '200':
3794
+ description: Success
3795
+ body:
3796
+ application/json:
3797
+ type: ManagedContentSpaceFolderItemCollectionRepresentation
3798
+ body:
3799
+ application/json:
3800
+ type: ManagedContentSpaceFolderItemCollectionInputRep
3801
+ #required: false # TODO hand rolled. W-9275477
3802
+ (oas-body-name): folderItemsPatchInput
3803
+ uriParameters:
3804
+ folderId:
3805
+ type: string
3806
+ required: true
3807
+ /items/search:
3808
+ get:
3809
+ description: Get Request to search for Managed Content items (folders or
3810
+ variants) within the specified content spaces or folders
3811
+ responses:
3812
+ '200':
3813
+ description: Success
3814
+ body:
3815
+ application/json:
3816
+ type: ManagedContentSearchResultItemsCollectionRepresentation
3817
+ queryParameters:
3818
+ contentSpaceOrFolderIds:
3819
+ type: array
3820
+ required: false
3821
+ items:
3822
+ type: string
3823
+ (oas-collectionFormat): csv
3824
+ contentTypeFQN:
3825
+ type: string
3826
+ required: false
3827
+ languages:
3828
+ type: array
3829
+ required: false
3830
+ items:
3831
+ type: string
3832
+ (oas-collectionFormat): csv
3833
+ page:
3834
+ type: integer
3835
+ required: false
3836
+ pageSize:
3837
+ type: integer
3838
+ required: false
3839
+ queryTerm:
3840
+ type: string
3841
+ required: true # TODO Hand-rolled W-11998789
3842
+ scope:
3843
+ type: string
3844
+ required: false
3845
+ enum:
3846
+ - All
3847
+ - TitleOnly
3848
+ /schedules:
3849
+ post:
3850
+ description: Create a schedule for a deployment
3851
+ responses:
3852
+ '200':
3853
+ description: Success
3854
+ body:
3855
+ application/json:
3856
+ type: ManagedContentDeploymentRepresentation
3857
+ body:
3858
+ application/json:
3859
+ type: ManagedContentScheduleInputRepresentation
3860
+ #required: false # TODO hand rolled. W-9275477
3861
+ (oas-body-name): ScheduleInput
3862
+ /schedules/{deploymentId}:
3863
+ patch:
3864
+ description: Patch schedule date or cancel the specified scheduled deployment
3865
+ responses:
3866
+ '200':
3867
+ description: Success
3868
+ body:
3869
+ application/json:
3870
+ type: ManagedContentDeploymentRepresentation
3871
+ queryParameters:
3872
+ isCancelled:
3873
+ type: boolean
3874
+ required: false
3875
+ scheduleDate:
3876
+ type: string
3877
+ required: false
3878
+ uriParameters:
3879
+ deploymentId:
3880
+ type: string
3881
+ required: true
3882
+ /spaces:
3883
+ get:
3884
+ description: Get a collection of all accessible Authoring Managed Content
3885
+ Space records
3886
+ responses:
3887
+ '200':
3888
+ description: Success
3889
+ body:
3890
+ application/json:
3891
+ type: ManagedContentSpaceCollectionRepresentation
3892
+ queryParameters:
3893
+ page:
3894
+ type: integer
3895
+ required: false
3896
+ pageSize:
3897
+ type: integer
3898
+ required: false
3899
+ post:
3900
+ description: Create an Authoring Managed Content Space only
3901
+ responses:
3902
+ '200':
3903
+ description: Success
3904
+ body:
3905
+ application/json:
3906
+ type: ManagedContentSpaceRepresentation
3907
+ body:
3908
+ application/json:
3909
+ type:
3910
+ ManagedContentSpaceInputRepresentation
3911
+ #required: false # TODO hand rolled. W-9275477
3912
+ (oas-body-name): ManagedContentSpaceInput
3913
+ /spaces/{contentSpaceId}:
3914
+ get:
3915
+ description: Get a specific ManagedContentSpace record
3916
+ responses:
3917
+ '200':
3918
+ description: Success
3919
+ body:
3920
+ application/json:
3921
+ type: ManagedContentSpaceRepresentation
3922
+ patch:
3923
+ description: Update a specific ManagedContentSpace
3924
+ responses:
3925
+ '200':
3926
+ description: Success
3927
+ body:
3928
+ application/json:
3929
+ type: ManagedContentSpaceRepresentation
3930
+ body:
3931
+ application/json:
3932
+ type:
3933
+ ManagedContentSpaceInputRepresentation
3934
+ #required: false # TODO hand rolled. W-9275477
3935
+ (oas-body-name): ManagedContentSpaceInput
3936
+ uriParameters:
3937
+ contentSpaceId:
3938
+ type: string
3939
+ required: true
3940
+ /contents:
3941
+ /export:
3942
+ post:
3943
+ description: Create a Managed Content export job 2.0
3944
+ responses:
3945
+ '200':
3946
+ description: Success
3947
+ body:
3948
+ application/json:
3949
+ type: ManagedContentV2JobRepresentation
3950
+ body:
3951
+ application/json:
3952
+ type: ManagedContentExportContentV2JobRequestInputWrapperRep
3953
+ (oas-body-name): managedContentV2JobRequest
3954
+ uriParameters:
3955
+ contentSpaceId:
3956
+ type: string
3957
+ required: true
3958
+ /import:
3959
+ post:
3960
+ description: Create a Managed Content import job 2.0
3961
+ responses:
3962
+ '200':
3963
+ description: Success
3964
+ body:
3965
+ application/json:
3966
+ type: ManagedContentV2JobRepresentation
3967
+ body:
3968
+ application/json:
3969
+ type: ManagedContentImportV2JobRequestInputWrapperRep
3970
+ (oas-body-name): managedContentV2JobRequest
3971
+ uriParameters:
3972
+ contentSpaceId:
3973
+ type: string
3974
+ required: true
3975
+ /communities/{communityId}/managed-content/delivery:
3976
+ get:
3977
+ description: Get list of managed content versions.
3978
+ responses:
3979
+ '200':
3980
+ description: Success
3981
+ body:
3982
+ application/json:
3983
+ type: ManagedContentVersionCollectionRepresentation
3984
+ queryParameters:
3985
+ contentKeys:
3986
+ type: array
3987
+ required: false
3988
+ items:
3989
+ type: string
3990
+ (oas-collectionFormat): csv
3991
+ language:
3992
+ type: string
3993
+ required: false
3994
+ managedContentIds:
3995
+ type: array
3996
+ required: false
3997
+ items:
3998
+ type: string
3999
+ (oas-collectionFormat): csv
4000
+ managedContentType:
4001
+ type: string
4002
+ required: false
4003
+ page:
4004
+ type: integer
4005
+ required: false
4006
+ pageSize:
4007
+ type: integer
4008
+ required: false
4009
+ showAbsoluteUrl:
4010
+ type: boolean
4011
+ required: false
4012
+ topics:
4013
+ type: array
4014
+ required: false
4015
+ items:
4016
+ type: string
4017
+ (oas-collectionFormat): csv
4018
+ uriParameters:
4019
+ communityId:
4020
+ type: string
4021
+ required: true
4022
+ /communities/{communityId}/managed-content/delivery/contents:
4023
+ get:
4024
+ description: Get list of managed content versions.
4025
+ responses:
4026
+ '200':
4027
+ description: Success
4028
+ body:
4029
+ application/json:
4030
+ type: ManagedContentVersionInternalCollectionRepresentation
4031
+ queryParameters:
4032
+ collectionName:
4033
+ type: string
4034
+ required: false
4035
+ contentKeys:
4036
+ type: array
4037
+ required: false
4038
+ items:
4039
+ type: string
4040
+ (oas-collectionFormat): csv
4041
+ language:
4042
+ type: string
4043
+ required: false
4044
+ managedContentIds:
4045
+ type: array
4046
+ required: false
4047
+ items:
4048
+ type: string
4049
+ (oas-collectionFormat): csv
4050
+ managedContentType:
4051
+ type: string
4052
+ required: false
4053
+ page:
4054
+ type: integer
4055
+ required: false
4056
+ pageSize:
4057
+ type: integer
4058
+ required: false
4059
+ queryTerm:
4060
+ type: string
4061
+ required: false
4062
+ topics:
4063
+ type: array
4064
+ required: false
4065
+ items:
4066
+ type: string
4067
+ (oas-collectionFormat): csv
4068
+ urlNameInList:
4069
+ type: array
4070
+ required: false
4071
+ items:
4072
+ type: string
4073
+ (oas-collectionFormat): csv
4074
+ uriParameters:
4075
+ communityId:
4076
+ type: string
4077
+ required: true
4078
+ /communities/{communityId}/managed-content/delivery/contents/search:
4079
+ get:
4080
+ description: Get the contents related to search terms
4081
+ responses:
4082
+ '200':
4083
+ description: Success
4084
+ body:
4085
+ application/json:
4086
+ type: ManagedContentSearchResultCollectionRepresentation
4087
+ queryParameters:
4088
+ page:
4089
+ type: integer
4090
+ required: false
4091
+ pageSize:
4092
+ type: integer
4093
+ required: false
4094
+ queryTerm:
4095
+ type: string
4096
+ required: false
4097
+ scope:
4098
+ type: string
4099
+ required: false
4100
+ enum:
4101
+ - All
4102
+ - TitleOnly
4103
+ uriParameters:
4104
+ communityId:
4105
+ type: string
4106
+ required: true
4107
+ /managed-content:
4108
+ /content-spaces/{contentSpaceId}:
4109
+ /content-versions:
4110
+ post:
4111
+ description: Create a manage content version
4112
+ responses:
4113
+ '200':
4114
+ description: Success
4115
+ body:
4116
+ application/json:
4117
+ type: ManagedContentVersionInternalRepresentation
4118
+ body:
4119
+ application/json:
4120
+ type: ManagedContentVersionInputRep
4121
+ #required: false # TODO hand rolled. W-9275477
4122
+ (oas-body-name): contentVersion
4123
+ uriParameters:
4124
+ contentSpaceId:
4125
+ type: string
4126
+ required: true
4127
+ /content-versions/{managedContentVersionId}:
4128
+ get:
4129
+ description: Get a single managed content version
4130
+ responses:
4131
+ '200':
4132
+ description: Success
4133
+ body:
4134
+ application/json:
4135
+ type: ManagedContentVersionInternalRepresentation
4136
+ queryParameters:
4137
+ language:
4138
+ type: string
4139
+ required: false
4140
+ patch:
4141
+ description: Update a managed content version
4142
+ responses:
4143
+ '200':
4144
+ description: Success
4145
+ body:
4146
+ application/json:
4147
+ type: ManagedContentVersionInternalRepresentation
4148
+ body:
4149
+ application/json:
4150
+ type: ManagedContentVersionInputRep
4151
+ #required: false # TODO hand rolled. W-9275477
4152
+ (oas-body-name): contentVersion
4153
+ uriParameters:
4154
+ contentSpaceId:
4155
+ type: string
4156
+ required: true
4157
+ managedContentVersionId:
4158
+ type: string
4159
+ required: true
4160
+ /contents/{managedContentId}:
4161
+ delete:
4162
+ description: Delete a nonpublished managed content given its Id
4163
+ responses:
4164
+ '200':
4165
+ description: Success
4166
+ patch:
4167
+ description: Update a managed content
4168
+ responses:
4169
+ '200':
4170
+ description: Success
4171
+ body:
4172
+ application/json:
4173
+ type: ManagedContentRepresentation
4174
+ body:
4175
+ application/json:
4176
+ type: ManagedContentInputRep
4177
+ #required: false # TODO hand rolled. W-9275477
4178
+ (oas-body-name): contentVersion
4179
+ uriParameters:
4180
+ contentSpaceId:
4181
+ type: string
4182
+ required: true
4183
+ managedContentId:
4184
+ type: string
4185
+ required: true
4186
+ /members:
4187
+ get:
4188
+ description: Get the members of a content space
4189
+ responses:
4190
+ '200':
4191
+ description: Success
4192
+ body:
4193
+ application/json:
4194
+ type: ManagedContentSpaceMemberCollectionRepresentation
4195
+ post:
4196
+ description: Add a member with a role to a content space
4197
+ responses:
4198
+ '200':
4199
+ description: Success
4200
+ body:
4201
+ application/json:
4202
+ type: ManagedContentSpaceMemberRepresentation
4203
+ body:
4204
+ application/json:
4205
+ type: ManagedContentSpaceMemberInputRepresentation
4206
+ #required: false # TODO hand rolled. W-9275477
4207
+ (oas-body-name): member
4208
+ uriParameters:
4209
+ contentSpaceId:
4210
+ type: string
4211
+ required: true
4212
+ /members/{memberIdOrMe}:
4213
+ delete:
4214
+ description: Delete the membership in a content space for a member
4215
+ responses:
4216
+ '200':
4217
+ description: Success
4218
+ patch:
4219
+ description: Update the membership in a content space for a member with
4220
+ a new role
4221
+ responses:
4222
+ '200':
4223
+ description: Success
4224
+ body:
4225
+ application/json:
4226
+ type: ManagedContentSpaceMemberRepresentation
4227
+ body:
4228
+ application/json:
4229
+ type: ManagedContentSpaceMemberInputRepresentation
4230
+ #required: false # TODO hand rolled. W-9275477
4231
+ (oas-body-name): member
4232
+ uriParameters:
4233
+ contentSpaceId:
4234
+ type: string
4235
+ required: true
4236
+ memberIdOrMe:
4237
+ type: string
4238
+ required: true
4239
+ /members/{memberIdOrMe}/permissions:
4240
+ get:
4241
+ description: Get the permissions for a member in a content space
4242
+ responses:
4243
+ '200':
4244
+ description: Success
4245
+ body:
4246
+ application/json:
4247
+ type: ManagedContentSpaceMemberPermissionsRepresentation
4248
+ uriParameters:
4249
+ contentSpaceId:
4250
+ type: string
4251
+ required: true
4252
+ memberIdOrMe:
4253
+ type: string
4254
+ required: true
4255
+ /roles:
4256
+ get:
4257
+ description: Get the roles available in a content space
4258
+ responses:
4259
+ '200':
4260
+ description: Success
4261
+ body:
4262
+ application/json:
4263
+ type: ManagedContentSpaceRoleCollectionRepresentation
4264
+ queryParameters:
4265
+ roleQueryScope:
4266
+ type: string
4267
+ required: false
4268
+ enum:
4269
+ - AuthoringRole
4270
+ - SiteRole
4271
+ /translation:
4272
+ post:
4273
+ description: Create a translation job
4274
+ responses:
4275
+ '200':
4276
+ description: Success
4277
+ body:
4278
+ application/json:
4279
+ type: ManagedContentTranslationRepresentation
4280
+ body:
4281
+ application/json:
4282
+ type: ManagedContentTranslationRequestInputRep
4283
+ #required: false # TODO hand rolled. W-9275477
4284
+ (oas-body-name): translationRequest