Method HIUGCStartSessionAgnostic

HIUGCStartSessionAgnostic(String, String, String, Boolean, AuthoringSessionStarter)

Starts a new authoring session to edit an asset.

Declaration

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

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.
AuthoringSessionStarter	starter	Starter object that describes who is starting the session and the previous version of the asset.

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

Was successful with a POST to https://{HaloCoreEndpoints.AuthoringOrigin}.{HaloCoreEndpoints.ServiceDomain}/hi/UgcGameVariants/9bc31094-8326-42ee-85d5-12e48ee1b129/sessions

Game variant has to be local to the account

POSTed content is like this:

{

"PreviousVersionId": "974c6f1a-9e86-4719-8b70-d055d370bc75",

"SessionOrigin": "xuid(XUID_VALUE)"

}

It also seems that using includeContainerSas results in a 403 response, but without it a session can be created.

Examples

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

   {
       "ContainerUri": "https://s3infiniteugcsessions.blob.core.windows.net/z-022dd3f5-09e6-4a1b-ad00-18420cc30bf6",
       "ContainerSas": "",
       "ExpirationTime": {
           "ISO8601Date": "2022-07-18T22:47:58.824Z"
       },
       "ReadOnly": false,
       "SessionId": "022dd3f5-09e6-4a1b-ad00-18420cc30bf6",
       "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": "",
           "FileRelativePaths": [],
           "PrefixEndpoint": {
               "AuthorityId": "",
               "Path": "",
               "QueryString": null,
               "RetryPolicyId": "",
               "TopicName": "",
               "AcknowledgementTypeId": 0,
               "AuthenticationLifetimeExtensionSupported": false,
               "ClearanceAware": false
           }
       }
   }