Documentation Index

Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt

Use this file to discover all available pages before exploring further.

/api/facts/{factType}/{factId}

Prev Next
Get
/api/facts/{factType}/{factId}
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
Min length0
Max length128
x-onBehalfOf
string
Min length0
Max length24
api-version
string
Path parameters
factType
stringRequired
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" ]
factId
stringRequired
Min length0
Max length128
Responses
200

OK

Expand All
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
namedDataDictionaries
Array of object (Contracts.Connect.Results.Facts.SelectNamedDataDictionary) | null
object
fact
object (Contracts.Common.Jsons.Refs.FactRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
externalId
string | null
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" ]
factType
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" ]
json
string | null
400

Bad Request

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*
404

Not Found

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500

Internal Server Error