openapi: 3.0.3 info: title: MediaValet BrandedPortals API description: |- The MediaValet API is a RESTful, JSON, hypermedia-driven service that supplies data to clients consuming the MediaValet cloud digital asset management (DAM) platform. The service applies business rules, permission rules, and other data processing to standardize what is returned. Requests go to the API gateway at https://api.mediavalet.com and must carry two credentials: an OAuth 2.0 / OpenID Connect Bearer access token issued by https://login.mediavalet.com/connect/token, and a per-account subscription key in the Ocp-Apim-Subscription-Key header. Requests also carry an x-mv-api-version header to select the API version. Access requires a MediaValet subscription and registration in the MediaValet Developer Portal at https://developer.mediavalet.com. PROVENANCE: this definition is derived operation-for-operation from MediaValet's own published Postman collection ("MediaValet API", collection 55cc404f-b818-43ba-87c2-1a07f2a47bd9) served at https://docs.mediavalet.com/api/collections/15676803/TzRUB7XE. Paths, methods, parameters, request bodies, response status codes and examples come from that collection. Schemas are inferred from the collection's request/response example payloads and are indicative rather than authoritative. version: '1.0' contact: name: MediaValet url: https://developer.mediavalet.com termsOfService: https://www.mediavalet.com/terms-of-service servers: - url: https://api.mediavalet.com description: MediaValet API gateway (public) security: - oauth2: - api subscriptionKey: [] tags: - name: BrandedPortals description: Branded Portals — externally shareable, branded views onto a subset of the library. paths: /brandedportals: get: operationId: retrieveBrandedPortals summary: Retrieve Branded Portals description: Returns branded portals. tags: - BrandedPortals parameters: - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: array items: type: object properties: id: type: string format: uuid name: type: string publicLiveUrl: type: string status: type: string createdAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string hasUnpublishedChanges: type: boolean pageViews: type: integer downloads: type: string sharedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string viewAccessGroupCount: type: integer _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: cillum_ec_: type: object sunt_: type: object temporee: type: object interpolations: type: object properties: quis_f: type: object permissions: type: array items: type: string example: - id: name: publicLiveUrl: status: Draft createdAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: hasUnpublishedChanges: pageViews: downloads: sharedBy: id: username: firstName: lastName: viewAccessGroupCount: _links: self: functions: - - translationKeys: cillum_ec_: {} sunt_: {} temporee: {} interpolations: quis_f: {} permissions: - lightbox:viewAsset - brandedPortal:view - id: name: publicLiveUrl: status: Unknown createdAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: hasUnpublishedChanges: pageViews: downloads: sharedBy: id: username: firstName: lastName: viewAccessGroupCount: _links: self: functions: - - translationKeys: ea_: {} interpolations: do_1_: {} veniam3ed: {} veniam__: {} permissions: - asset:downloadFromPortal - None '403': description: The user does not have permission to perform this operation. '500': description: The request failed because of a problem on the server. post: operationId: createBrandedPortal summary: Create Branded Portal description: Creates a branded portal. tags: - BrandedPortals parameters: - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string host: type: string path: type: string pageLayout: type: string language: type: string example: id: name: host: path: pageLayout: language: FR responses: '201': description: The branded portal was successfully created. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '409': description: Conflict has occurred. Either duplicate name or url. '500': description: The request failed because of a problem on the server. /brandedportals/assets: get: operationId: searchBrandedPortalAssets summary: Search Branded Portal Assets description: Returns assets form a search results in a branded portal. tags: - BrandedPortals parameters: - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: assetCount: type: integer assets: type: array items: type: object properties: id: type: string format: uuid title: type: string media: type: object properties: type: type: string small: type: string thumb: type: string large: type: string medium: type: string download: type: string preview: type: string downloadRequest: type: string stream: type: string streamingManifest: type: string sasExpiry: type: integer sasRenewal: type: integer renditionItemCount: type: integer autodeskUrn: type: string file: type: object properties: title: type: string fileName: type: string fileType: type: string visible: type: boolean brandedPortalVersionSections: type: object properties: occaecatc: type: array items: type: string permissions: type: object properties: all: type: array items: type: object properties: name: type: string example: assetCount: assets: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecatc: - - permissions: all: - name: - name: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecat3: - - proident__: - - permissions: all: - name: - name: '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}: get: operationId: retrieveBrandedPortal summary: Retrieve Branded Portal description: Returns a branded portal by branded portal id. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '403': description: The user does not have permission to perform this operation. '404': description: A branded portal was not found. '500': description: The request failed because of a problem on the server. delete: operationId: removeBrandedPortal summary: Remove Branded Portal description: Remove a branded portal by branded portal id. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '204': description: No Content, Request was successful Response is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found by the branded portal id given. '500': description: The request failed because of a problem on the server. /public/brandedportals/{host}/{path}: get: operationId: retrieveLiveBrandedPortal summary: Retrieve Live Branded Portal description: Returns a live branded portal. tags: - BrandedPortals parameters: - name: host in: path required: true description: host path parameter. schema: type: string - name: path in: path required: true description: path path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid libraryId: type: string format: uuid version: type: string format: uuid libraryName: type: string host: type: string path: type: string pageLayout: type: string navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean downloadSettings: type: object properties: allowDownloads: type: boolean highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string lastPublishedAt: type: string format: date-time defaultLogoFilePath: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string example: id: libraryId: version: libraryName: host: path: pageLayout: navigationSettings: showNavigation: searchSettings: allowSearch: downloadSettings: allowDownloads: highlightColourSettings: highlightColour: languageSettings: language: EN brandedPortalMultiLanguageLinks: - language: FR url: - language: FR url: lastPublishedAt: defaultLogoFilePath: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/policies: get: operationId: getAllPoliciesOfABrandedportals summary: Get all policies of a brandedportals description: Only user with Manage Branded Portal permissions can get policies. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: apiVersion: type: string buildVersion: type: string warnings: type: array items: type: string errors: type: array items: type: string payload: type: array items: type: object properties: policyId: type: integer subject: type: object properties: subjectId: type: string format: uuid subjectType: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: ut66: type: object ut_61f: type: object non_d_d: type: object interpolations: type: object properties: laborum_93: type: object permissions: type: array items: type: string resource: type: object properties: resourceId: type: string format: uuid resourceType: type: string predicate: type: object properties: predicateType: type: string predicateId: type: string format: uuid predicateValues: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: amet3: type: object interpolations: type: object properties: in387: type: object permissions: type: array items: type: string inherited: type: boolean _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: veniam0: type: object velit_4_2: type: object occaecat_9: type: object interpolations: type: object properties: sintb5c: type: object commodo2: type: object permissions: type: array items: type: string grant: type: object properties: grantType: type: string grantName: type: string allowed: type: boolean _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: ad_c: type: object interpolations: type: object properties: laboris_0_1: type: object Ut_6c8: type: object aute02: type: object permissions: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consectetur877: type: object aliquipe: type: object est_f_: type: object interpolations: type: object properties: sit1: type: object Ut_44: type: object permissions: type: array items: type: string recordCount: type: object properties: totalRecordsFound: type: integer startingRecord: type: integer recordsReturned: type: integer meta: type: object properties: metaInformation: type: object properties: enim_8: type: object Duis5c: type: object createdAt: type: string format: date-time example: apiVersion: buildVersion: warnings: - - errors: - - payload: - policyId: subject: subjectId: subjectType: _links: self: functions: - - translationKeys: ut66: {} ut_61f: {} non_d_d: {} interpolations: laborum_93: {} permissions: - asset:shareAsZippedFile - None resource: resourceId: resourceType: predicate: predicateType: predicateId: predicateValues: _links: self: functions: - - translationKeys: amet3: {} interpolations: in387: {} permissions: - lightbox:share - asset:shareAsLink inherited: _links: self: functions: - - translationKeys: veniam0: {} velit_4_2: {} occaecat_9: {} interpolations: sintb5c: {} commodo2: {} permissions: - lightbox:transferOwnership - asset:assignCategory grant: grantType: grantName: allowed: _links: self: functions: - - translationKeys: ad_c: {} interpolations: laboris_0_1: {} Ut_6c8: {} aute02: {} permissions: - asset:shareAsBrandedPortal - brandedPortal:view _links: self: functions: - - translationKeys: consectetur877: {} aliquipe: {} est_f_: {} interpolations: sit1: {} Ut_44: {} permissions: - asset:shareAsBrandedPortal - asset:shareAsCdnLink - policyId: subject: subjectId: subjectType: _links: self: functions: - - translationKeys: dolor_0: {} interpolations: anime: {} sunt_8e: {} permissions: - asset:shareAsWebGallery - asset:shareAsZippedFile resource: resourceId: resourceType: predicate: predicateType: predicateId: predicateValues: _links: self: functions: - - translationKeys: cupidatat37d: {} interpolations: exercitation_e: {} permissions: - asset:assignCategory - asset:shareAsLightbox inherited: _links: self: functions: - - translationKeys: eiusmode: {} nisi_c: {} interpolations: ullamco52f: {} adipisicing_c: {} permissions: - asset:shareAsCdnLink - lightbox:share grant: grantType: grantName: allowed: _links: self: functions: - - translationKeys: deserunt_f: {} Utd: {} tempor_fb: {} interpolations: reprehenderitb39: {} permissions: - user:editEmail - asset:shareAsLink _links: self: functions: - - translationKeys: proident__1: {} Excepteur__8: {} fugiate: {} interpolations: aliquae6: {} permissions: - asset:shareAsLightbox - asset:shareAsCdnLink recordCount: totalRecordsFound: startingRecord: recordsReturned: meta: metaInformation: enim_8: {} Duis5c: {} createdAt: '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. post: operationId: updatesPolicyOfBrandedPortal summary: Updates policy of branded portal tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: policyUpdateRequestId: type: integer reasonForChange: type: string addedPolicies: type: array items: type: object properties: policyId: type: integer subject: type: object properties: subjectId: type: string format: uuid subjectType: type: string resource: type: object properties: resourceId: type: string format: uuid resourceType: type: string predicate: type: object properties: predicateType: type: string predicateId: type: string format: uuid predicateValues: type: string inherited: type: boolean grant: type: object properties: grantType: type: string grantName: type: string allowed: type: boolean removedPolicies: type: array items: type: integer notification: type: object properties: entityIds: type: array items: type: string format: uuid notificationEntityType: type: string userGroups: type: array items: type: string format: uuid users: type: array items: type: string format: uuid userEmails: type: array items: type: string message: type: string example: policyUpdateRequestId: reasonForChange: addedPolicies: - policyId: subject: subjectId: subjectType: resource: resourceId: resourceType: predicate: predicateType: predicateId: predicateValues: inherited: grant: grantType: grantName: allowed: - policyId: subject: subjectId: subjectType: resource: resourceId: resourceType: predicate: predicateType: predicateId: predicateValues: inherited: grant: grantType: grantName: allowed: removedPolicies: - - notification: entityIds: - - notificationEntityType: Category userGroups: - - users: - - userEmails: - - message: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: apiVersion: type: string buildVersion: type: string warnings: type: array items: type: string errors: type: array items: type: string payload: type: array items: type: object properties: actionTypes: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: minime: type: object interpolations: type: object properties: eu3_1: type: object non3: type: object eiusmod_7b: type: object permissions: type: array items: type: string recordCount: type: object properties: totalRecordsFound: type: integer startingRecord: type: integer recordsReturned: type: integer meta: type: object properties: metaInformation: type: object properties: quid_: type: object exercitation55: type: object createdAt: type: string format: date-time example: apiVersion: buildVersion: warnings: - - errors: - - payload: - actionTypes: - - _links: self: functions: - - translationKeys: minime: {} interpolations: eu3_1: {} non3: {} eiusmod_7b: {} permissions: - asset:shareAsWebGallery - brandedPortal:view - actionTypes: - - _links: self: functions: - - translationKeys: cupidatat2dc: {} interpolations: veniam_63: {} permissions: - asset:createImageCrop - lightbox:transferOwnership recordCount: totalRecordsFound: startingRecord: recordsReturned: meta: metaInformation: quid_: {} exercitation55: {} createdAt: '400': description: There was a problem with the data sent with the request. '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/categories/{categoryId}/assets: get: operationId: retrieveBrandedPortalAssetsByCategoryId summary: Retrieve Branded Portal Assets By CategoryId description: Returns a collection of assets by categoryId in a branded portal. tags: - BrandedPortals parameters: - name: categoryId in: path required: true description: categoryId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: assetCount: type: integer assets: type: array items: type: object properties: id: type: string format: uuid title: type: string media: type: object properties: type: type: string small: type: string thumb: type: string large: type: string medium: type: string download: type: string preview: type: string downloadRequest: type: string stream: type: string streamingManifest: type: string sasExpiry: type: integer sasRenewal: type: integer renditionItemCount: type: integer autodeskUrn: type: string file: type: object properties: title: type: string fileName: type: string fileType: type: string visible: type: boolean brandedPortalVersionSections: type: object properties: occaecatc: type: array items: type: string permissions: type: object properties: all: type: array items: type: object properties: name: type: string example: assetCount: assets: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecatc: - - permissions: all: - name: - name: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecat3: - - proident__: - - permissions: all: - name: - name: '403': description: Server refused the request. '404': description: The category was not found. '500': description: The request failed because of a problem on the server. /brandedportals/lightboxes/{lightboxId}/assets: get: operationId: retrieveBrandedPortalAssetsByLightboxId summary: Retrieve Branded Portal Assets By LightboxId description: Returns a collection of asset by lightboxId in a branded portal. tags: - BrandedPortals parameters: - name: lightboxId in: path required: true description: lightboxId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: assetCount: type: integer assets: type: array items: type: object properties: id: type: string format: uuid title: type: string media: type: object properties: type: type: string small: type: string thumb: type: string large: type: string medium: type: string download: type: string preview: type: string downloadRequest: type: string stream: type: string streamingManifest: type: string sasExpiry: type: integer sasRenewal: type: integer renditionItemCount: type: integer autodeskUrn: type: string file: type: object properties: title: type: string fileName: type: string fileType: type: string visible: type: boolean brandedPortalVersionSections: type: object properties: occaecatc: type: array items: type: string permissions: type: object properties: all: type: array items: type: object properties: name: type: string example: assetCount: assets: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecatc: - - permissions: all: - name: - name: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecat3: - - proident__: - - permissions: all: - name: - name: '401': description: The current user is not authorized to view this lightbox. '403': description: The user does not have permission to perform this operation. '404': description: The lightbox was not found. '500': description: The request failed because of a problem on the server. /public/brandedportals/{host}/termsAndConditions: get: operationId: retrieveBrandedPortalTermsAndConditions summary: Retrieve Branded Portal Terms and Conditions description: Returns the terms and condititons of a branded portal. tags: - BrandedPortals parameters: - name: host in: path required: true description: host path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: libraryName: type: string displayTermsAndConditions: type: boolean termsAndConditionsNotice: type: string termsAndConditionsUpdated: type: string format: date-time example: libraryName: displayTermsAndConditions: termsAndConditionsNotice: termsAndConditionsUpdated: '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/{sectionId}/sync: get: operationId: getBrandedPortalSectionSyncDetails summary: Get branded portal section sync details description: Return branded portal section sync details tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: brandedPortalId: type: string format: uuid versionId: type: string format: uuid sectionId: type: string format: uuid syncType: type: string categoryId: type: string format: uuid lightboxId: type: string format: uuid name: type: string treePath: type: string treeIdPath: type: string example: brandedPortalId: versionId: sectionId: syncType: Category categoryId: lightboxId: name: treePath: treeIdPath: '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. post: operationId: createSectionSync summary: Create section sync description: Sync Branded Portal section. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: categoryId: type: string format: uuid lightboxId: type: string format: uuid example: categoryId: lightboxId: responses: '204': description: No Content, Request was successful Response is null. '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/accesskey: get: operationId: retrieveBrandedPortalAccessKey summary: Retrieve Branded Portal Access Key description: Returns a branded portal access key. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/assets: get: operationId: searchBrandedPortalDraftAssets summary: Search Branded Portal Draft Assets description: Returns search results from branded portal draft assets. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: preview in: query required: false description: preview query parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: assetCount: type: integer assets: type: array items: type: object properties: id: type: string format: uuid title: type: string media: type: object properties: type: type: string small: type: string thumb: type: string large: type: string medium: type: string download: type: string preview: type: string downloadRequest: type: string stream: type: string streamingManifest: type: string sasExpiry: type: integer sasRenewal: type: integer renditionItemCount: type: integer autodeskUrn: type: string file: type: object properties: title: type: string fileName: type: string fileType: type: string visible: type: boolean brandedPortalVersionSections: type: object properties: occaecatc: type: array items: type: string permissions: type: object properties: all: type: array items: type: object properties: name: type: string example: assetCount: assets: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecatc: - - permissions: all: - name: - name: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecat3: - - proident__: - - permissions: all: - name: - name: '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. delete: operationId: removeAssetsFormABrandedPortal summary: Remove Assets Form A Branded Portal. description: Remove assets form a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: false content: application/json: schema: type: array items: type: string format: uuid example: - - responses: '204': description: No Content, Request was successful Response is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /public/{libraryId}/brandedportals/{brandedPortalId}/assets: get: operationId: searchALiveBrandedPortal summary: Search A Live Branded Portal description: Returns search results for a live branded portal. tags: - BrandedPortals parameters: - name: libraryId in: path required: true description: libraryId path parameter. schema: type: string - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: assetCount: type: integer assets: type: array items: type: object properties: id: type: string format: uuid title: type: string media: type: object properties: type: type: string small: type: string thumb: type: string large: type: string medium: type: string download: type: string preview: type: string downloadRequest: type: string stream: type: string streamingManifest: type: string sasExpiry: type: integer sasRenewal: type: integer renditionItemCount: type: integer autodeskUrn: type: string file: type: object properties: title: type: string fileName: type: string fileType: type: string example: assetCount: assets: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/sections/{sectionId}/uploads: get: operationId: retrieveBrandedPortalUploadSectionDetails summary: Retrieve Branded Portal Upload Section Details description: Return branded portal upload section details tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: brandedPortalId: type: string format: uuid versionId: type: string format: uuid sectionId: type: string format: uuid categoryIds: type: array items: type: string format: uuid example: brandedPortalId: versionId: sectionId: categoryIds: - - '403': description: The user does not have permission to perform this operation. '404': description: The branded portal or upload section was not found. '500': description: The request failed because of a problem on the server. put: operationId: updateBrandedPortalUploadSection summary: Update Branded Portal Upload Section description: Update a branded portal upload section by branded portal id and upload section id. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: categoryIds: type: array items: type: string format: uuid example: categoryIds: - - responses: '204': description: No Content, Request was successful Response is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found by the branded portal id given. '500': description: The request failed because of a problem on the server. post: operationId: createBrandedPortalUploadSection summary: Create Branded Portal Upload Section description: Create branded portal upload section. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: categoryIds: type: array items: type: string format: uuid example: categoryIds: - - responses: '204': description: No Content, Request was successful. Response is null. '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. delete: operationId: removeBrandedPortalUploadSection summary: Remove Branded Portal Upload Section description: Remove a branded portal upload section by branded portal id and upload section id. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '204': description: No Content, Request was successful Response is null. '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found by the branded portal id given. '500': description: The request failed because of a problem on the server. /public/{libraryId}/brandedportals/{brandedPortalId}/renditionKinds: get: operationId: retrievesBrandedPortalAssetRenditionTypes summary: Retrieves Branded Portal Asset Rendition Types description: Retrieves all the rendition types available for the given Branded Portal. tags: - BrandedPortals parameters: - name: libraryId in: path required: true description: libraryId path parameter. schema: type: string - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: array items: type: object properties: renditionKindId: type: string format: uuid code: type: integer description: type: string height: type: integer isDefault: type: boolean mimeType: type: string name: type: string quality: type: integer targetFileExtension: type: string width: type: integer colorspace: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consectetur9de: type: object ex_f32: type: object interpolations: type: object properties: labore16f: type: object dolor5: type: object amet38d: type: object permissions: type: array items: type: string example: - renditionKindId: code: description: height: isDefault: mimeType: name: quality: targetFileExtension: width: colorspace: _links: self: functions: - - translationKeys: consectetur9de: {} ex_f32: {} interpolations: labore16f: {} dolor5: {} amet38d: {} permissions: - asset:shareAsWebGallery - user:editEmail - renditionKindId: code: description: height: isDefault: mimeType: name: quality: targetFileExtension: width: colorspace: _links: self: functions: - - translationKeys: veniam_25c: {} qui__ec: {} mollit_c: {} interpolations: sit_36d: {} laborumf4: {} quis_1: {} nulla56: {} permissions: - asset:downloadFromMvd - asset:shareAsLightbox '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/{sectionId}/assets: get: operationId: retrieveBrandedPortalDraftAssets summary: Retrieve Branded Portal Draft Assets description: Returns draft assets in a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: preview in: query required: false description: preview query parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: assetCount: type: integer assets: type: array items: type: object properties: id: type: string format: uuid title: type: string media: type: object properties: type: type: string small: type: string thumb: type: string large: type: string medium: type: string download: type: string preview: type: string downloadRequest: type: string stream: type: string streamingManifest: type: string sasExpiry: type: integer sasRenewal: type: integer renditionItemCount: type: integer autodeskUrn: type: string file: type: object properties: title: type: string fileName: type: string fileType: type: string visible: type: boolean brandedPortalVersionSections: type: object properties: occaecatc: type: array items: type: string permissions: type: object properties: all: type: array items: type: object properties: name: type: string example: assetCount: assets: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecatc: - - permissions: all: - name: - name: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: visible: brandedPortalVersionSections: occaecat3: - - proident__: - - permissions: all: - name: - name: '403': description: The user does not have permission to perform this operation. '404': description: A branded portal was not found. '500': description: The request failed because of a problem on the server. post: operationId: createAssetsInBrandedPortalSection summary: Create Assets In Branded Portal Section description: Adds assets too a branded portal section. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: array items: type: string format: uuid example: - - responses: '204': description: No Content, Request was successful Response is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. delete: operationId: removeAssetsFormABrandedPortalSection summary: Remove Assets Form A Branded Portal Section description: Remove assets form a branded portal section. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: false content: application/json: schema: type: array items: type: string format: uuid example: - - responses: '204': description: No Content, Request was successful Response is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /public/{libraryId}/brandedportals/{brandedPortalId}/{sectionId}/assets: get: operationId: retrieveAssetsFormALiveBrandedPortal summary: Retrieve Assets Form A Live Branded Portal description: Returns assets form a live branded portal. tags: - BrandedPortals parameters: - name: libraryId in: path required: true description: libraryId path parameter. schema: type: string - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: assetCount: type: integer assets: type: array items: type: object properties: id: type: string format: uuid title: type: string media: type: object properties: type: type: string small: type: string thumb: type: string large: type: string medium: type: string download: type: string preview: type: string downloadRequest: type: string stream: type: string streamingManifest: type: string sasExpiry: type: integer sasRenewal: type: integer renditionItemCount: type: integer autodeskUrn: type: string file: type: object properties: title: type: string fileName: type: string fileType: type: string example: assetCount: assets: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: - id: title: media: type: small: thumb: large: medium: download: preview: downloadRequest: stream: streamingManifest: sasExpiry: sasRenewal: renditionItemCount: autodeskUrn: file: title: fileName: fileType: '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /public/{libraryId}/brandedportals/{brandedPortalId}/downloads/{downloadId}: get: operationId: retrieveLiveBrandedPortalAssets summary: Retrieve Live Branded Portal Assets description: Retrieve a live branded portal assets. tags: - BrandedPortals parameters: - name: libraryId in: path required: true description: libraryId path parameter. schema: type: string - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: downloadId in: path required: true description: downloadId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /public/{libraryId}/brandedportals/{brandedPortalId}/assets/{assetId}/renditions/{renditionKindId}: get: operationId: retrieveBrandedPortalsAssetRendition summary: Retrieve Branded Portals Asset Rendition description: Retrieves a specific rendition for a given published Branded Portal asset. tags: - BrandedPortals parameters: - name: libraryId in: path required: true description: libraryId path parameter. schema: type: string - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: assetId in: path required: true description: assetId path parameter. schema: type: string - name: renditionKindId in: path required: true description: renditionKindId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: renditionUrl: type: string thumbnailUrl: type: string pages: type: object properties: count: type: integer offSet: type: integer renditions: type: array items: type: object properties: sequence: type: integer url: type: string sasExpiry: type: integer sasRenewal: type: integer example: renditionUrl: thumbnailUrl: pages: count: offSet: renditions: - sequence: url: - sequence: url: sasExpiry: sasRenewal: '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The asset rendition was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/name: put: operationId: updateBrandedPortalName summary: Update Branded Portal Name description: Update the branded portal name. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: false content: text/plain: schema: type: string responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string publicLiveUrl: type: string status: type: string createdAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string hasUnpublishedChanges: type: boolean pageViews: type: integer downloads: type: string sharedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string viewAccessGroupCount: type: integer _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: nostrudb4a: type: object dolorf8: type: object interpolations: type: object properties: minimbd1: type: object consectetur90c: type: object permissions: type: array items: type: string example: id: name: publicLiveUrl: status: Live createdAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: hasUnpublishedChanges: pageViews: downloads: sharedBy: id: username: firstName: lastName: viewAccessGroupCount: _links: self: functions: - - translationKeys: nostrudb4a: {} dolorf8: {} interpolations: minimbd1: {} consectetur90c: {} permissions: - asset:downloadFromMvd - asset:shareAsLink '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: A branded portal was not found. '409': description: Conflict has occurred. Duplicate branded portal. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/layout: put: operationId: updateBrandedPortal summary: Update Branded Portal description: Update the branded portal page layout. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: false content: text/plain: schema: type: string responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: A branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/url: put: operationId: updateBrandedPortalURLSettings summary: Update Branded Portal URL Settings description: Update the URL settings for a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: host: type: string path: type: string example: host: path: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: A branded portal was not found. '409': description: Conflict has occurred. Duplicate portal url. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/search: put: operationId: updateBrandedPortalSearchSettings summary: Update Branded Portal Search Settings description: Update the search settings for branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: allowSearch: type: boolean example: allowSearch: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: Bad Request. Search settings is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/download: put: operationId: updateBrandedPortalDownloadSettings summary: Update Branded Portal Download Settings description: Update download settings for a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: allowDownloads: type: boolean example: allowDownloads: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: Bad Request. The download setting was null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/language: put: operationId: updateBrandedPortalLanguageSettings summary: Update Branded Portal Language Settings description: Update language settings for a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string example: language: FR brandedPortalMultiLanguageLinks: - language: EN url: - language: FR url: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: Bad Request. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/navigation: put: operationId: updateBrandedPortalNavigationSettings summary: Update Branded Portal Navigation Settings description: Update navigation for a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: showNavigation: type: boolean example: showNavigation: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: Bad Request. The navigation settings were null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/restrictaccess: put: operationId: updateBrandedPortalAccessSettings summary: Update Branded Portal Access Settings description: Update the restricted access settings for branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: requireAccessKey: type: boolean accessKey: type: string example: requireAccessKey: accessKey: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: Bad Request. Restricted access settings is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/settings/highlightcolour: put: operationId: updateBrandedPortalHighlightColour summary: Update Branded Portal Highlight Colour description: Update highlight colour for a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: highlightColour: type: string example: highlightColour: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: Bad Request. Highlight colour settings is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/validate/assets: post: operationId: validateAssetsInAllBrandedPortals summary: Validate Assets In All Branded Portals description: Validates assets in all branded portal. tags: - BrandedPortals parameters: - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: array items: type: string format: uuid example: - - responses: '200': description: Request was successful. content: application/json: schema: type: array items: type: string format: uuid example: - - '403': description: The user does not have permission to perform this operation. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/disable: post: operationId: disableBrandedPortal summary: Disable Branded Portal description: Disable branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/publish: post: operationId: publishBrandedPortal summary: Publish Branded Portal description: Publish branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '409': description: Conflict has occurred. Branded portal URL already exists. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/duplicate: post: operationId: createDuplicateBrandedPortal summary: Create Duplicate Branded Portal description: Duplicates a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string host: type: string path: type: string brandedPortalVersion: type: string example: id: name: host: path: brandedPortalVersion: Draft responses: '201': description: The branded portal was successfully created. content: application/json: schema: type: object properties: id: type: string format: uuid liveVersion: type: string format: uuid draftVersion: type: string format: uuid name: type: string status: type: string createdAt: type: string format: date-time host: type: string path: type: string liveHost: type: string livePath: type: string pageLayout: type: string lastPublishedAt: type: string format: date-time draftModifiedAt: type: string format: date-time lastModifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string downloadSettings: type: object properties: allowDownloads: type: boolean navigationSettings: type: object properties: showNavigation: type: boolean searchSettings: type: object properties: allowSearch: type: boolean restrictAccessSettings: type: object properties: requireAccessKey: type: boolean accessKey: type: string highlightColourSettings: type: object properties: highlightColour: type: string languageSettings: type: object properties: language: type: string brandedPortalMultiLanguageLinks: type: array items: type: object properties: language: type: string url: type: string skinColors: type: object properties: backgroundAssetCardColor: type: string backgroundAssetCardHeaderColor: type: string backgroundHeaderColor: type: string backgroundMainColor: type: string backgroundPageColor: type: string backgroundReviewActionsColor: type: string buttonColor: type: string buttonInactiveColor: type: string highlightColor: type: string lineColor: type: string overlayColor: type: string tableOddRowColor: type: string textColor: type: string textHighlightColor: type: string textInactiveColor: type: string treeFolderColor: type: string textTreeColor: type: string backgroundTableHeaderColor: type: string backgroundModalHeaderColor: type: string focusOutlineColor: type: string defaultLogoFilePath: type: string pageViews: type: integer downloads: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: consequatcc9: type: object occaecat_40e: type: object interpolations: type: object properties: cupidatat_b35: type: object minim_6: type: object ad8: type: object sed_66d: type: object permissions: type: array items: type: string example: id: liveVersion: draftVersion: name: status: Disabled createdAt: host: path: liveHost: livePath: pageLayout: lastPublishedAt: draftModifiedAt: lastModifiedBy: id: username: firstName: lastName: downloadSettings: allowDownloads: navigationSettings: showNavigation: searchSettings: allowSearch: restrictAccessSettings: requireAccessKey: accessKey: highlightColourSettings: highlightColour: languageSettings: language: FR brandedPortalMultiLanguageLinks: - language: FR url: - language: EN url: skinColors: backgroundAssetCardColor: backgroundAssetCardHeaderColor: backgroundHeaderColor: backgroundMainColor: backgroundPageColor: backgroundReviewActionsColor: buttonColor: buttonInactiveColor: highlightColor: lineColor: overlayColor: tableOddRowColor: textColor: textHighlightColor: textInactiveColor: treeFolderColor: textTreeColor: backgroundTableHeaderColor: backgroundModalHeaderColor: focusOutlineColor: defaultLogoFilePath: pageViews: downloads: _links: self: functions: - - translationKeys: consequatcc9: {} occaecat_40e: {} interpolations: cupidatat_b35: {} minim_6: {} ad8: {} sed_66d: {} permissions: - user:editEmail - asset:shareAsLightbox '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: A branded portal was not found. '409': description: Conflict has occurred. Either duplicate name or url. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/move/assets: post: operationId: moveAssetsToABrandedPortalSection summary: Move Assets To A Branded Portal Section description: Move assets to a branded portal section. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: assetIds: type: array items: type: string format: uuid sourceSectionId: type: string format: uuid destinationSectionId: type: string format: uuid example: assetIds: - - sourceSectionId: destinationSectionId: responses: '204': description: No Content, Request was successful Response is null. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /public/brandedportals/{host}/{path}/authorize: post: operationId: authorizeBrandedPortalAccess summary: Authorize Branded Portal Access description: Authorize access for branded portal. tags: - BrandedPortals parameters: - name: host in: path required: true description: host path parameter. schema: type: string - name: path in: path required: true description: path path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: false content: text/plain: schema: type: string responses: '200': description: Request was successful. '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/validate/assets: post: operationId: validateAssetsInABrandedPortal summary: Validate Assets In A Branded Portal description: Validate assets in a branded portal. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: array items: type: string format: uuid example: - - responses: '200': description: Request was successful. content: application/json: schema: type: array items: type: object properties: assetId: type: string format: uuid assetFile: type: object properties: title: type: string fileName: type: string fileType: type: string sectionIds: type: array items: type: string format: uuid _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: laborum1c3: type: object dolore_99: type: object interpolations: type: object properties: ea_80: type: object est4: type: object permissions: type: array items: type: string example: - assetId: assetFile: title: fileName: fileType: sectionIds: - - _links: self: functions: - - translationKeys: laborum1c3: {} dolore_99: {} interpolations: ea_80: {} est4: {} permissions: - asset:assignCategory - asset:createImageCrop - assetId: assetFile: title: fileName: fileType: sectionIds: - - _links: self: functions: - - translationKeys: ullamco_5a: {} incididunt_45e: {} interpolations: exercitation_0: {} permissions: - asset:createImageCrop - asset:downloadFromPortal '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /brandedportals/{brandedPortalId}/{sectionId}/unsync: post: operationId: removeSectionSync summary: Remove section sync description: Unsync Branded Portal section. tags: - BrandedPortals parameters: - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: sectionId in: path required: true description: sectionId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: categoryId: type: string format: uuid lightboxId: type: string format: uuid example: categoryId: lightboxId: responses: '204': description: No Content, Request was successful Response is null. '400': description: There was a problem with the data sent with the request. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. /public/{libraryId}/brandedportals/{brandedPortalId}/downloads: post: operationId: createADownloadLiveBrandedPortalAssets summary: Create A Download Live Branded Portal Assets description: Returns a live branded portal assets. tags: - BrandedPortals parameters: - name: libraryId in: path required: true description: libraryId path parameter. schema: type: string - name: brandedPortalId in: path required: true description: brandedPortalId path parameter. schema: type: string - name: x-mv-api-version in: header required: false description: (Required) The requested API version schema: type: string example: '1.2' requestBody: required: true content: application/json: schema: type: object properties: assetIds: type: array items: type: string format: uuid sectionId: type: string format: uuid zipFileName: type: string type: type: string example: assetIds: - - sectionId: zipFileName: type: BrandedPortal responses: '200': description: Request was successful. content: application/json: schema: type: object properties: DownloadId: type: string format: uuid ZipFileName: type: string AssetIds: type: array items: type: string format: uuid SectionId: type: string format: uuid Type: type: string example: DownloadId: ZipFileName: AssetIds: - - SectionId: Type: Asset '401': description: The current user is not authorized to view this end-point. '403': description: The user does not have permission to perform this operation. '404': description: The branded portal was not found. '500': description: The request failed because of a problem on the server. components: securitySchemes: oauth2: type: oauth2 description: OAuth 2.0 / OpenID Connect issued by https://iam.mediavalet.com via https://login.mediavalet.com. Send the access token as a Bearer Authorization header. flows: authorizationCode: authorizationUrl: https://login.mediavalet.com/connect/authorize tokenUrl: https://login.mediavalet.com/connect/token refreshUrl: https://login.mediavalet.com/connect/token scopes: openid: OpenID Connect identity profile: User profile claims api: Access the MediaValet API api:service_principal: Service-principal (machine) access to the MediaValet API iam.admin: Administer MediaValet identity and access management iam.provisioning: Provision users and organizations offline_access: Obtain a refresh token clientCredentials: tokenUrl: https://login.mediavalet.com/connect/token scopes: api: Access the MediaValet API api:service_principal: Service-principal (machine) access to the MediaValet API password: tokenUrl: https://login.mediavalet.com/connect/token scopes: openid: OpenID Connect identity api: Access the MediaValet API offline_access: Obtain a refresh token subscriptionKey: type: apiKey in: header name: Ocp-Apim-Subscription-Key description: Per-account API subscription key issued through the MediaValet Developer Portal (Azure API Management).