GET content/{contentId}

Related

Get content details by ID. This is a faceted view with the following facets:

Facet Examples

GET /api/v1/content/fbca3f66-e33b-4125-8384-c753a10d659f HTTP/1.1
Accept: application/json
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
ETag: ...

{
  "id": "fbca3f66-e33b-4125-8384-c753a10d659f",
  "revisionId": "c83ffc2e-25b0-48ac-9c5f-51e638ecb30b",
  "listingId": 231,
  "author": {
    "id": "c13c874c-a9d6-487a-b331-a1118ca995a3",
    "username": "iRefactor",
    "avatar": "protected/us-west-2:c13c874c-a9d6-487a-b331-a1118ca995a3/ddcdfa09-cc3e-45ea-b977-dc178481a7bd.png",
    "emblem": null
  },
  "status": "active",
  "type": "game",
  "maxFileSize": 214326,
  "version": "2",
  "created": 1537907432,
  "updated": 1537907471,
  "name": "test6",
  "description": "asdfasdfasdfsadf",
  "screenshotUris": ["protected/us-west-2:c13c874c-a9d6-487a-b331-a1118ca995a3/fbca3f66-e33b-4125-8384-c753a10d659f/699b56e5-c605-454c-aa86-c7059f4566c1.png"],
  "tags": [],
  "featured": true,
  "featuredListingId": 301,
  "downloads": "0",
  "views": "23",
  "upvotes": "100",
  "downvotes": "100",
  "rating": "0.5"
}

Security

Authentication is not generally required for this method, but certain content items are restricted to certain users based on their status.

URL Parameters

NameDescriptionValue
contentIdthe ID of the content as a GUID with dashesstring

Query Parameters

NameDescriptionValue
facetselect a facet to return optional
one of:
  • revisions
  • manifest

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response: default facet

NameDescriptionValue
idthe ID of the content as a GUID with dashesstring
revisionIdthe ID of the revision as a GUID with dashesstring
listingIdthe ID of the most recent listingnumber
authoran object describing the author of the contentobject; UserSimplified
statusthe status of the content item
one of:
  • active
  • suspended
  • deleted
typethe category of the content item
one of:
  • game
  • asset
  • avatar_box
  • gameplay_box
  • scene_box
maxFileSizethe sum of the file sizes of all dependencies for the latest revision, in bytesnumber
versionthe version number of the latest revisionstring
createdwhen this item was first published, as a unix timestampnumber
updatedwhen this item was last updated, as a unix timestampnumber
namethe name of this content itemstring
descriptionthe description of this content itemstring
screenshotUrisan array of screenshots, as paths relative to the media S3 bucket; the first screenshot is assumed to be the primary imagearray of strings
tagsan array of tags assigned to this contentarray of strings
featuredtrue if this content is featured, false otherwiseboolean
featuredListingIdthe listing ID that is featured, if this content is featurednumber or null
downloadsthe number of times this content has been downloadednumber
viewsthe number of times this content has been viewednumber
upvotesthe number of times this content has been upvotednumber
downvotesthe number of times this content has been downvotednumber
ratingthe calculated rating for this content; a value between 0 and 1number

UserSimplified

NameDescriptionValue
idthe ID of the user as a GUID with dashesstring
usernamethe user's username, which is uniquestring
avatara media path to the user's avatar image file; will be null if no avatar has been setstring or null
emblemthe GUID of an emblem to display with the user's avatar, or null if none is selectedstring or null

Response: manifest facet

Everything from the default facet plus:

NameDescriptionValue
manifesta description of the dependencies for this content itemobject; see manifest definition

Response: revisions facet

Everything from the default facet except: revisionId, version, maxFileSize, and updated; and plus:

NameDescriptionValue
revisionsan array of revision objects describing all known revisions to this content itemarray of objects; see Revision

Revision

NameDescriptionValue
idthe revision ID as a GUID with dashesstring
contentIdthe content ID as a GUID with dashesstring
createdwhen this revision was published, as a unix timestampnumber
descriptionthe change notes for this revisionstring
versionthe version number for this revisionstring
maxFileSizethe sum of the file sizes of all dependencies for this revision, in bytesnumber