@salesforce/lds-adapters-cms-type 0.131.0

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