Method HIUGCExtendSessionAgnostic

HIUGCExtendSessionAgnostic(String, String, String, Boolean)

Extends an existing authoring session.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.AssetAuthoringSession,Den.Dev.Grunt.Models.RawResponseContainer>> HIUGCExtendSessionAgnostic (string title, string assetType, string assetId, bool includeContainerSas);

Parameters

Type	Name	Description
System.String	title	Title for the game for which the authoring session needs to be spawned. Example variant is "hi" for "Halo Infinite".
System.String	assetType	Type of asset to check. Example value is "UgcGameVariants".
System.String	assetId	Unique asset ID for the asset type specified earlier.
System.Boolean	includeContainerSas	Determines whether to include the container SAS in the response or not. Setting this value to "true" will result in a 403 Forbidden error.

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<AssetAuthoringSession,RawResponseContainer>>	If successful, returns an instance of AssetAuthoringSession with details about the created session. Otherwise, returns null.

Remarks

For now, an empty JSON is passed to the PATCH request. In the future, analysis needs to be done to understand more about how the request actually

can be used to modify the data, since that's what a PATCH is usually about.

Examples

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

   {
       "ContainerUri": "https://s3infiniteugcsessions.blob.core.windows.net/z-74ccd1d0-ebec-4a52-a848-4edab1a0a8d2",
       "ContainerSas": "",
       "ExpirationTime": {
           "ISO8601Date": "2022-07-19T03:25:00.432Z"
       },
       "ReadOnly": false,
       "SessionId": "74ccd1d0-ebec-4a52-a848-4edab1a0a8d2",
       "AssetId": "b5ed517c-ce50-4919-95b2-41197f644ad6",
       "CustomData": {
           "KeyValues": {}
       },
       "PublicName": "MultiTeam",
       "Description": "",
       "Tags": [],
       "Links": {
           "EngineGameVariant": [
               {
                   "TargetAssetId": "6ada47c6-fedd-4a46-9761-e6c4a8ed11bd",
                   "TargetAssetVersionId": null,
                   "Order": 0
               }
           ]
       },
       "Contributors": [],
       "StringCulture": "",
       "PreviousAssetVersionId": "3deff683-01e4-4e2a-927b-33a77c12d5fe",
       "ContainerFiles": {
           "Prefix": "https://s3infiniteugcsessions.blob.core.windows.net/z-74ccd1d0-ebec-4a52-a848-4edab1a0a8d2/",
           "FileRelativePaths": [],
           "PrefixEndpoint": {
               "AuthorityId": "iUgcSessionFiles",
               "Path": "/z-74ccd1d0-ebec-4a52-a848-4edab1a0a8d2/",
               "QueryString": null,
               "RetryPolicyId": "linearretry",
               "TopicName": "",
               "AcknowledgementTypeId": 0,
               "AuthenticationLifetimeExtensionSupported": false,
               "ClearanceAware": false
           }
       }
   }