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