Method HIUGCListAllVersions

HIUGCListAllVersions(String, String, String)

Gets information about all versions for a specified asset.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.AuthoringAssetVersionContainer,Den.Dev.Grunt.Models.RawResponseContainer>> HIUGCListAllVersions (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<AuthoringAssetVersionContainer,RawResponseContainer>>	If successful, returns an instance of AuthoringAssetVersionContainer that contains information about all available versions for an asset. Otherwise, returns null.

Remarks

The underlying request supports specifying parameters that limit the search, such as ?start=number, however that is not yet implemented in this version of the API wrapper.

Examples

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

   {
       "Start": 0,
       "Count": 13,
       "ResultCount": 1,
       "Results": [
           {
               "CustomData": {
                   "KeyValues": {}
               },
               "AssetVersionFiles": {
                   "Prefix": "",
                   "FileRelativePaths": [],
                   "PrefixEndpoint": {
                       "AuthorityId": "",
                       "Path": "",
                       "QueryString": null,
                       "RetryPolicyId": "",
                       "TopicName": "",
                       "AcknowledgementTypeId": 0,
                       "AuthenticationLifetimeExtensionSupported": false,
                       "ClearanceAware": false
                   }
               },
               "Links": {
                   "EngineGameVariant": [
                       {
                           "TargetAssetId": "5308a91a-4499-4a04-8764-861ad5803a21",
                           "TargetAssetVersionId": null,
                           "Order": 0
                       }
                   ]
               },
               "AssetId": "f96f57e2-9f15-45c5-83ac-5775a48d2ba8",
               "AssetVersionId": "2674c887-7aa1-42ab-a6cd-4a2c60611d0e",
               "PublicName": "Arena:Attrition",
               "Description": "Deplete the enemy’s respawns and then wipe them out.",
               "CreatedDate": {
                   "ISO8601Date": "2022-05-23T23:59:02.154Z"
               },
               "LastModifiedDate": {
                   "ISO8601Date": "2022-05-23T23:59:18.306Z"
               },
               "VersionNumber": 1,
               "Note": "",
               "AssetState": 1,
               "Tags": [],
               "Contributors": [],
               "AssetHome": 2,
               "ExemptFromAutoDelete": false,
               "InspectionResult": 0,
               "CloneBehavior": 0,
               "Player": "xuid(PLAYER_XUID_HERE)",
               "StringCulture": "",
               "PreviousAssetVersionId": null
           }
       ],
       "Links": {}
   }