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