openapi: 3.0.3 info: title: MediaValet Lightbox 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: Lightbox description: Lightboxes — user-curated collections of assets. paths: /lightboxes/{lightboxId}/assets: get: operationId: retrieveLightboxAssets summary: Retrieve Lightbox Assets description: Retrieves the assets for a given lightbox id. tags: - Lightbox 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. '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 lightbox was not found. '500': description: The request failed because of a problem on the server. post: operationId: createLightboxAssociationWithAssets summary: Create Lightbox Association With Assets description: Add a set of assets to the lightbox. tags: - Lightbox 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' 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: - - '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. delete: operationId: removeAssetsFromLightbox summary: Remove Assets From Lightbox description: Removes a set of assets from a given lightbox. tags: - Lightbox 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' requestBody: required: false 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: - - '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 lightbox was not found. '500': description: The request failed because of a problem on the server. /lightboxes/lightboxesForApproval: get: operationId: retrieveLightboxesForApproval summary: Retrieve Lightboxes For Approval description: Retrieves list of lightboxes for approval. tags: - Lightbox 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 description: type: string assetCount: type: integer owner: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string approverId: type: string format: uuid record: type: object properties: createdAt: type: string format: date-time createdBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string modifiedAt: type: string format: date-time modifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string softDeletedAt: type: string format: date-time softDeletedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string version: type: object properties: version: type: integer current: type: string format: uuid head: type: string format: uuid parentid: type: string format: uuid isversionable: type: boolean islatestversion: type: boolean ismajorversion: type: boolean requestedAt: type: string format: date-time includedInBrandedPortalSync: type: boolean syncedBrandedPortals: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: sitf: type: object velit6: type: object interpolations: type: object properties: labore80: type: object fugiat96: type: object permissions: type: array items: type: string example: - id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: sitf: {} velit6: {} interpolations: labore80: {} fugiat96: {} permissions: - asset:downloadFromMvd - user:editEmail - id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: aliquip_49: {} interpolations: do_715: {} dolore_2: {} nisi751: {} quisec: {} ut_8: {} permissions: - asset:shareAsZippedFile - asset:createImageCrop '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. /lightboxes/{lightboxId}/policies: get: operationId: returnAllPoliciesOfALightbox summary: Return all policies of a Lightbox description: Only Lightbox owner can get policies. tags: - Lightbox 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: id: type: string format: uuid name: type: string description: type: string assetCount: type: integer owner: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string approverId: type: string format: uuid record: type: object properties: createdAt: type: string format: date-time createdBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string modifiedAt: type: string format: date-time modifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string softDeletedAt: type: string format: date-time softDeletedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string version: type: object properties: version: type: integer current: type: string format: uuid head: type: string format: uuid parentid: type: string format: uuid isversionable: type: boolean islatestversion: type: boolean ismajorversion: type: boolean requestedAt: type: string format: date-time includedInBrandedPortalSync: type: boolean syncedBrandedPortals: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: enim_9cb: type: object officia_f: type: object deserunt_df: type: object dolor810: type: object interpolations: type: object properties: eiusmode2f: type: object permissions: type: array items: type: string example: id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: enim_9cb: {} officia_f: {} deserunt_df: {} dolor810: {} interpolations: eiusmode2f: {} permissions: - asset:downloadFromPortal - brandedPortal:view '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 lightbox was not found. '500': description: The request failed because of a problem on the server. post: operationId: lightboxUpdateLightboxPolicies summary: Lightbox Update Lightbox Policies tags: - Lightbox 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' 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. '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 lightbox was not found. '500': description: The request failed because of a problem on the server. /lightboxes: get: operationId: retrieveLightboxes summary: Retrieve Lightboxes description: Retrieves all lightboxes. tags: - Lightbox parameters: - name: includePermissions in: query required: false description: includePermissions 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: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string assetCount: type: integer owner: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string approverId: type: string format: uuid record: type: object properties: createdAt: type: string format: date-time createdBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string modifiedAt: type: string format: date-time modifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string softDeletedAt: type: string format: date-time softDeletedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string version: type: object properties: version: type: integer current: type: string format: uuid head: type: string format: uuid parentid: type: string format: uuid isversionable: type: boolean islatestversion: type: boolean ismajorversion: type: boolean requestedAt: type: string format: date-time includedInBrandedPortalSync: type: boolean syncedBrandedPortals: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: sitf: type: object velit6: type: object interpolations: type: object properties: labore80: type: object fugiat96: type: object permissions: type: array items: type: string example: - id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: sitf: {} velit6: {} interpolations: labore80: {} fugiat96: {} permissions: - asset:downloadFromMvd - user:editEmail - id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: aliquip_49: {} interpolations: do_715: {} dolore_2: {} nisi751: {} quisec: {} ut_8: {} permissions: - asset:shareAsZippedFile - asset:createImageCrop '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. post: operationId: createLightbox summary: Create Lightbox description: Creates a new lightbox. tags: - Lightbox 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 description: type: string approverId: type: string format: uuid example: id: name: description: approverId: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string description: type: string assetCount: type: integer owner: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string approverId: type: string format: uuid record: type: object properties: createdAt: type: string format: date-time createdBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string modifiedAt: type: string format: date-time modifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string softDeletedAt: type: string format: date-time softDeletedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string version: type: object properties: version: type: integer current: type: string format: uuid head: type: string format: uuid parentid: type: string format: uuid isversionable: type: boolean islatestversion: type: boolean ismajorversion: type: boolean requestedAt: type: string format: date-time includedInBrandedPortalSync: type: boolean syncedBrandedPortals: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: enim_9cb: type: object officia_f: type: object deserunt_df: type: object dolor810: type: object interpolations: type: object properties: eiusmode2f: type: object permissions: type: array items: type: string example: id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: enim_9cb: {} officia_f: {} deserunt_df: {} dolor810: {} interpolations: eiusmode2f: {} permissions: - asset:downloadFromPortal - brandedPortal:view '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. '500': description: The request failed because of a problem on the server. /lightboxes/lightboxesForApproval/{lightboxId}/assets: get: operationId: retrieveAssetsFromLightboxForApproval summary: Retrieve Assets From Lightbox For Approval description: Retrieves the assets from a specific lightbox for approval. tags: - Lightbox 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. '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. /lightboxes/{lightboxId}: get: operationId: retrieveLightbox summary: Retrieve Lightbox description: Retrieves lightbox for a given lightbox id. tags: - Lightbox parameters: - name: lightboxId in: path required: true description: lightboxId path parameter. schema: type: string - name: includePermissions in: query required: false description: includePermissions 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: id: type: string format: uuid name: type: string description: type: string assetCount: type: integer owner: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string approverId: type: string format: uuid record: type: object properties: createdAt: type: string format: date-time createdBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string modifiedAt: type: string format: date-time modifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string softDeletedAt: type: string format: date-time softDeletedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string version: type: object properties: version: type: integer current: type: string format: uuid head: type: string format: uuid parentid: type: string format: uuid isversionable: type: boolean islatestversion: type: boolean ismajorversion: type: boolean requestedAt: type: string format: date-time includedInBrandedPortalSync: type: boolean syncedBrandedPortals: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: enim_9cb: type: object officia_f: type: object deserunt_df: type: object dolor810: type: object interpolations: type: object properties: eiusmode2f: type: object permissions: type: array items: type: string example: id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: enim_9cb: {} officia_f: {} deserunt_df: {} dolor810: {} interpolations: eiusmode2f: {} permissions: - asset:downloadFromPortal - brandedPortal:view '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 lightbox was not found. '500': description: The request failed because of a problem on the server. put: operationId: updateLightbox summary: Update Lightbox description: Updates the lightbox details. tags: - Lightbox 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' requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string description: type: string approverId: type: string format: uuid example: id: name: description: approverId: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string description: type: string assetCount: type: integer owner: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string approverId: type: string format: uuid record: type: object properties: createdAt: type: string format: date-time createdBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string modifiedAt: type: string format: date-time modifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string softDeletedAt: type: string format: date-time softDeletedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string version: type: object properties: version: type: integer current: type: string format: uuid head: type: string format: uuid parentid: type: string format: uuid isversionable: type: boolean islatestversion: type: boolean ismajorversion: type: boolean requestedAt: type: string format: date-time includedInBrandedPortalSync: type: boolean syncedBrandedPortals: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: enim_9cb: type: object officia_f: type: object deserunt_df: type: object dolor810: type: object interpolations: type: object properties: eiusmode2f: type: object permissions: type: array items: type: string example: id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - - translationKeys: enim_9cb: {} officia_f: {} deserunt_df: {} dolor810: {} interpolations: eiusmode2f: {} permissions: - asset:downloadFromPortal - brandedPortal:view '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. delete: operationId: removeLightbox summary: Remove Lightbox description: Removes a given lightbox id. tags: - Lightbox 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. '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. patch: operationId: updateLightbox2 summary: Update Lightbox description: Update lightbox with a list of patch operations. tags: - Lightbox 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' requestBody: required: true content: application/json: schema: type: array items: type: object properties: op: type: string path: type: string value: type: object from: type: string example: - op: path: value: {} from: - op: path: value: {} from: responses: '200': description: Request was successful. content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string description: type: string assetCount: type: integer owner: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string approverId: type: string format: uuid record: type: object properties: createdAt: type: string format: date-time createdBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string modifiedAt: type: string format: date-time modifiedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string softDeletedAt: type: string format: date-time softDeletedBy: type: object properties: id: type: string format: uuid username: type: string firstName: type: string lastName: type: string version: type: object properties: version: type: integer current: type: string format: uuid head: type: string format: uuid parentid: type: string format: uuid isversionable: type: boolean islatestversion: type: boolean ismajorversion: type: boolean requestedAt: type: string format: date-time includedInBrandedPortalSync: type: boolean syncedBrandedPortals: type: array items: type: string _links: type: object properties: self: type: string functions: type: array items: type: string translationKeys: type: object properties: enim_9cb: type: object officia_f: type: object deserunt_df: type: object dolor810: type: object interpolations: type: object properties: eiusmode2f: type: object permissions: type: array items: type: string example: id: name: description: assetCount: owner: id: username: firstName: lastName: approverId: record: createdAt: createdBy: id: username: firstName: lastName: modifiedAt: modifiedBy: id: username: firstName: lastName: softDeletedAt: softDeletedBy: id: username: firstName: lastName: version: version: current: head: parentid: isversionable: islatestversion: ismajorversion: requestedAt: includedInBrandedPortalSync: syncedBrandedPortals: - - _links: self: functions: - -