Get
/api/media/{library}/{mediaId}
Security
OAuth
Authorization using OAuth2 with Client Credentials
FlowClient Credentials
Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
Header parameters
x-correlationToken
string
x-clientId
string
x-onBehalfOf
string
api-version
string
Path parameters
library
stringRequired
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
mediaId
stringRequired
Responses
200
OK
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
name
string | null
code
string | null
id
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
displayName
string | null
durationSecs
number (double)
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
mid
string | null
eTag
string | null
lastWriteTime
string (date-time) | null
tags
Array of object (Contracts.Connect.Results.Media.SelectMediaResultTagJson) | null
object
type
string
Valid values[
"None",
"Profile",
"Zone",
"Whatever",
"MediaFormat",
"Permission",
"Application",
"Cluster",
"ContentType",
"Item",
"POSItem",
"Assortment",
"Record",
"Location",
"Region",
"Offer",
"Customer",
"PlayerFeature",
"AI",
"Media",
"Player",
"LocationRef"
]
id
string | null
name
string | null
facts
Array of object (Contracts.Connect.Results.Media.SelectMediaResultFactJson) | null
object
type
string
Valid values[
"None",
"Item",
"Offer",
"HousingAdProduct",
"HousingAd",
"Menu",
"SocialMediaFeed",
"SocialMediaAlbum",
"SocialMediaPost",
"NamedRecord",
"MediaDictionary",
"ItemSalesStatistics",
"Items",
"ItemSalesStatistic",
"POSItem",
"POSItems",
"ScheduledPeriods",
"ItemStockBalance",
"ItemStockBalances",
"Offers",
"Assortment",
"Assortments",
"Records",
"Record",
"ScheduledPeriodName"
]
code
string | null
id
string | null
name
string | null
aspects
Array of string | null
string
data
Array of object (Contracts.Connect.Results.Media.SelectMediaResultDataJson) | null
object
dataType
string
Valid values[
"None",
"FormData",
"TemplateConfigJson",
"Xmp",
"WebPage",
"Fallback",
"CommitId"
]
data
string | null
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
name
string | null
code
string | null
id
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
displayName
string | null
durationSecs
number (double)
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
mid
string | null
eTag
string | null
lastWriteTime
string (date-time) | null
tags
Array of object (Contracts.Connect.Results.Media.SelectMediaResultTagJson) | null
object
type
string
Valid values[
"None",
"Profile",
"Zone",
"Whatever",
"MediaFormat",
"Permission",
"Application",
"Cluster",
"ContentType",
"Item",
"POSItem",
"Assortment",
"Record",
"Location",
"Region",
"Offer",
"Customer",
"PlayerFeature",
"AI",
"Media",
"Player",
"LocationRef"
]
id
string | null
name
string | null
facts
Array of object (Contracts.Connect.Results.Media.SelectMediaResultFactJson) | null
object
type
string
Valid values[
"None",
"Item",
"Offer",
"HousingAdProduct",
"HousingAd",
"Menu",
"SocialMediaFeed",
"SocialMediaAlbum",
"SocialMediaPost",
"NamedRecord",
"MediaDictionary",
"ItemSalesStatistics",
"Items",
"ItemSalesStatistic",
"POSItem",
"POSItems",
"ScheduledPeriods",
"ItemStockBalance",
"ItemStockBalances",
"Offers",
"Assortment",
"Assortments",
"Records",
"Record",
"ScheduledPeriodName"
]
code
string | null
id
string | null
name
string | null
aspects
Array of string | null
string
data
Array of object (Contracts.Connect.Results.Media.SelectMediaResultDataJson) | null
object
dataType
string
Valid values[
"None",
"FormData",
"TemplateConfigJson",
"Xmp",
"WebPage",
"Fallback",
"CommitId"
]
data
string | null
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
name
string | null
code
string | null
id
string | null
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
displayName
string | null
durationSecs
number (double)
mediaType
string
Valid values[
"None",
"Audio",
"Video",
"Photo",
"Text",
"HtmlSign",
"Json",
"HtmlTemplate",
"WebPage",
"File"
]
mid
string | null
eTag
string | null
lastWriteTime
string (date-time) | null
tags
Array of object (Contracts.Connect.Results.Media.SelectMediaResultTagJson) | null
object
type
string
Valid values[
"None",
"Profile",
"Zone",
"Whatever",
"MediaFormat",
"Permission",
"Application",
"Cluster",
"ContentType",
"Item",
"POSItem",
"Assortment",
"Record",
"Location",
"Region",
"Offer",
"Customer",
"PlayerFeature",
"AI",
"Media",
"Player",
"LocationRef"
]
id
string | null
name
string | null
facts
Array of object (Contracts.Connect.Results.Media.SelectMediaResultFactJson) | null
object
type
string
Valid values[
"None",
"Item",
"Offer",
"HousingAdProduct",
"HousingAd",
"Menu",
"SocialMediaFeed",
"SocialMediaAlbum",
"SocialMediaPost",
"NamedRecord",
"MediaDictionary",
"ItemSalesStatistics",
"Items",
"ItemSalesStatistic",
"POSItem",
"POSItems",
"ScheduledPeriods",
"ItemStockBalance",
"ItemStockBalances",
"Offers",
"Assortment",
"Assortments",
"Records",
"Record",
"ScheduledPeriodName"
]
code
string | null
id
string | null
name
string | null
aspects
Array of string | null
string
data
Array of object (Contracts.Connect.Results.Media.SelectMediaResultDataJson) | null
object
dataType
string
Valid values[
"None",
"FormData",
"TemplateConfigJson",
"Xmp",
"WebPage",
"Fallback",
"CommitId"
]
data
string | null
400
Bad Request
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
401
Unauthorized
403
Forbidden
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
404
Not Found
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500
Internal Server Error