@salesforce/lds-adapters-experience-model 0.1.0-dev1

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