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