Method HIUGCGetAsset

HIUGCGetAsset(String, String, String)

Gets authoring metadata about a specific asset.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.AuthoringAsset,Den.Dev.Grunt.Models.RawResponseContainer>> HIUGCGetAsset (string title, string assetType, string assetId);

Parameters

Type	Name	Description
System.String	title	Title which contains the asset. An example value here is "hi".
System.String	assetType	Type of asset to check. Example value is "UgcGameVariants".
System.String	assetId	Unique ID for the asset. Example value is "f96f57e2-9f15-45c5-83ac-5775a48d2ba8" for "Attrition-Default-UGC".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<AuthoringAsset,RawResponseContainer>>	If successful, returns an instance of AuthoringAsset containing authoring metadata. Otherwise, returns null.

Examples

Here is an example response from the API, as snapshotted on 7/8/2022:

   {
       "AssetId": "f96f57e2-9f15-45c5-83ac-5775a48d2ba8",
       "Kind": 6,
       "OriginalOwner": "xuid(PLAYER_XUID_HERE)",
       "Admin": "xuid(PLAYER_XUID_HERE)",
       "LastModifiedDateUtc": {
           "ISO8601Date": "2022-05-23T23:59:18.306Z"
       },
       "CreatedDateUtc": {
           "ISO8601Date": "2022-05-23T23:59:02.154Z"
       },
       "InternalName": "Attrition-Default-UGC",
       "Description": "",
       "HardDeleteTimeUtc": null,
       "Permissions": [
           {
               "CanonicalToken": "xuid(PLAYER_XUID_HERE)",
               "AuthoringRole": 6,
               "GrantedBy": "the_guardians",
               "GrantedOnDateUtc": {
                   "ISO8601Date": "2022-05-23T23:59:02.154Z"
               }
           }
       ],
       "AssetStats": {
           "Favorites": 0,
           "FilmBookmarks": 0,
           "Likes": 0,
           "Ratings": {
               "AverageRating": 0.0,
               "TotalCount": 0,
               "Ratings": []
           },
           "ParentAssetCount": 0,
           "LastModifiedDateUtc": {
               "ISO8601Date": "2022-05-24T00:09:51.562Z"
           },
           "IgnoreReports": false
       },
       "AssetHome": 2,
       "IsCurrentlyBeingEdited": false
   }