All pages
Powered by GitBook
1 of 10

Media

Media object

The Media object enables vendors to add, view, or delete media from the product object.

Field
Type
Description

id

string

href

string

name

string

The name of the media object.

Example: "Office 365 Product Image"

description

string

The description of the media object.

Example: "An image of Office 365 which is available to purchase within the Microsoft 365 Online Services product"

type

string

The type of the media object.

url

string

The URI to access media object.

Example: "https://address.to.media.file.pl/abcde.png"

displayOrder

integer

Media object order on list.

Example: "100"

status

string

Draft or Published.

product

Product Object

Example:

{
    "id": "PRD-1111-1111-1111",
    "href": "/catalog/products/PRD-1111-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
}

audit

Audit Object

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

Example

 {
    "id": "MED-1234-1234",
    "href": "v1/catalog-management/media/MED-1234-1234",
    "name": "Office 365 Product Image",
    "description": "An image of Office 365 which is available to purchase within the Microsoft 365 Online Services product",
    "type": "Image",
    "url": "https://address.to.media.file.pl/abcde.png",
    "displayOrder": 100,
    "state": "Draft",
    "product": {
      "id": "PRD-1111-1111-1111",
      "href": "/catalog/products/PRD-1111-1111-1111",
      "name": "Microsoft Office 365 NCE",
      "icon": "/static/PRD-1111-1111-1111/logo.png"
     },
    "audit": {
     "created": { "at": "...", "by": { } },
     "updated": { "at": "...", "by": { } }
   }
  }

Media States

The following diagram shows the possible states for the media object in the Marketplace Platform and the transition between these states:

Media state transition
State
Definition

Draft

The documentation object is being created by the vendor.

It is not visible to clients yet in the marketplace.

Pending

The vendor has submitted the documentation object to SoftwareOne Operations for review and publishing.

Published

The media object is visible in the marketplace.

Unpublished

The media object is not visible in the marketplace.

Deleted

The media object no longer exists.

It's no longer part of the product definition and can't be used.

Create Product Media

Create new media for a product.

post
Path parameters
productIdstringrequired
Body
mediaobjectoptional

Json representation of the media

filestring ยท binaryoptional
Responses
curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media' \
  --header 'Content-Type: multipart/form-data' \
  --form 'media=[object Object]' \
  --form 'file=binary'
{
  "domainEvents": [],
  "markedForDelete": true,
  "mediaId": {},
  "fileId": {},
  "url": "text",
  "displayOrder": {},
  "status": {},
  "isDeleted": true
}

Created

Get Product Media

Get an item of media for a product.

get
Path parameters
productIdstringrequired
idstringrequired
Query parameters
selectstringoptional
Responses
curl -L \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media/{id}'
{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "type": "text",
  "description": "text",
  "status": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "displayOrder": 1,
  "url": "text",
  "product": {}
}

Success

List Product Media

Get a list of media for a product.

get
Path parameters
productIdstringrequired
Responses
curl -L \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media'
{
  "$meta": {},
  "data": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "name": "text",
      "type": "text",
      "description": "text",
      "status": "text",
      "filename": "text",
      "size": 1,
      "contentType": "text",
      "displayOrder": 1,
      "url": "text",
      "product": {}
    }
  ]
}

Success

Update Media

Update the media for a product.

put
Path parameters
productIdstringrequired
idstringrequired
Body
idstringoptional
auditobjectoptional
$metaobjectoptional
hrefstringread-onlyoptional
namestringoptional
typestringoptional
descriptionstringoptional
statusstringoptional
filenamestringoptional
sizeinteger ยท int32optional
contentTypestringoptional
displayOrderinteger ยท int32optional
urlstringoptional
productobjectoptional
Responses
curl -L \
  --request PUT \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "audit": {},
    "$meta": {},
    "name": "text",
    "type": "text",
    "description": "text",
    "status": "text",
    "filename": "text",
    "size": 1,
    "contentType": "text",
    "displayOrder": 1,
    "url": "text",
    "product": {}
  }'
No Content

Success

Publish Media

Publish an item of media for a product.

post
Path parameters
productIdstringrequired
idstringrequired
Responses
curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media/{id}/publish'
{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "type": "text",
  "description": "text",
  "status": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "displayOrder": 1,
  "url": "text",
  "product": {}
}

Success

Unpublish Media

Unpublish an item of media for a product.

post
Path parameters
productIdstringrequired
idstringrequired
Responses
curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media/{id}/unpublish'
{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "type": "text",
  "description": "text",
  "status": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "displayOrder": 1,
  "url": "text",
  "product": {}
}

Success

Mark Media For Review

Mark an item of media for a product for review.

post
Path parameters
productIdstringrequired
idstringrequired
Responses
curl -L \
  --request POST \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media/{id}/review'
{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "type": "text",
  "description": "text",
  "status": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "displayOrder": 1,
  "url": "text",
  "product": {}
}

Success

Delete Media

Delete an item of media for a product.

delete
Path parameters
productIdstringrequired
idstringrequired
Responses
curl -L \
  --request DELETE \
  --url 'https://api.platform.softwareone.com/public/v1/products/{productId}/media/{id}'
No Content

No Content