Microsoft.MixedReality (preview:0.2.1)

2025/10/28 • 3 deleted methods

IngestionJob_Create (removed)
Description :  Creates a job request.
Reference :  Link ¶

⚼ Request

PUT:  /accounts/{accountId}/jobs/{jobId}
{
accountId:
{
Description: Identifier for the Azure Object Anchors account. ,
Format: uuid ,
Required: True ,
}
string ,
jobId:
{
Description: Identifier for the Azure Object Anchors ingestion job. ,
Format: uuid ,
Required: True ,
}
string ,
x-mrc-cv:
{
Description: The client request correlation vector, which should be set to a new value for each request. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version. ,
Required: False ,
}
string ,
body:
{
Description: The Azure Object Anchors ingestion request. ,
Required: False ,
}
{
clientErrorDetails:
{
Description: Information about the cause of a ClientError JobStatus. ,
Required: False ,
}
string ,
serverErrorDetails:
{
Description: Information about the cause of a ServerError JobStatus. ,
Required: False ,
}
string ,
errorCode:
{
Enum:
{
UNKNOWN: No description available. ,
NO_ERROR: No description available. ,
SERVICE_ERROR: No description available. ,
INVALID_ASSET_URI: No description available. ,
INVALID_JOB_ID: No description available. ,
INVALID_GRAVITY: No description available. ,
INVALID_SCALE: No description available. ,
ASSET_SIZE_TOO_LARGE: No description available. ,
ASSET_DIMENSIONS_OUT_OF_BOUNDS: No description available. ,
ZERO_FACES: No description available. ,
INVALID_FACE_VERTICES: No description available. ,
ZERO_TRAJECTORIES_GENERATED: No description available. ,
TOO_MANY_RIG_POSES: No description available. ,
ASSET_CANNOT_BE_CONVERTED: No description available. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Identifier for the AOA asset conversion job. ,
Format: uuid ,
Required: False ,
}
string ,
outputModelUri:
{
Description: The URI for downloading the generated AOA Model ,
Format: uri ,
Required: False ,
}
string ,
jobStatus:
{
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
assetFileType:
{
Description: The file type of the original 3D asset. Examples include: "ply", "obj", "fbx", "glb", "gltf", etc. ,
Required: False ,
}
string ,
inputAssetUri:
{
Description: The Uri to the Asset to be ingested by the AOA asset conversion service. This asset needs to have been uploaded to the service using an endpoint provided from a call to the GetUploadUri API. ,
Format: uri ,
Required: False ,
}
string ,
accountId:
{
Description: Identifier for the Account owning the asset conversion job. ,
Format: uuid ,
Required: False ,
}
string ,
ingestionConfiguration:
{
Description: Represents an ingestion configuration. ,
Required: False ,
}
{
dimensions:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
boundingBoxCenter:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
gravity:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
keyFrameIndexes:
{
Description: Indices of Key Frames. ,
Required: False ,
}
[
integer ,
]
,
gtTrajectory:
{
Description: Ground truth trajectory. ,
Required: False ,
}
[
{
rotation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
translation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
principalAxis:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
scale:
{
Description: Scale of transformation of asset units into meter space. ,
Format: float ,
Required: True ,
}
number ,
supportingPlane:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
}
,
testTrajectory:
{
Description: Test Trajectory. ,
Required: False ,
}
[
{
rotation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
translation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. ,
}
string ,
}
,
$schema:
{
Description: Represents the status of an AOA asset conversion job. ,
}
{
clientErrorDetails:
{
Description: Information about the cause of a ClientError JobStatus. ,
Required: False ,
}
string ,
serverErrorDetails:
{
Description: Information about the cause of a ServerError JobStatus. ,
Required: False ,
}
string ,
errorCode:
{
Enum:
{
UNKNOWN: No description available. ,
NO_ERROR: No description available. ,
SERVICE_ERROR: No description available. ,
INVALID_ASSET_URI: No description available. ,
INVALID_JOB_ID: No description available. ,
INVALID_GRAVITY: No description available. ,
INVALID_SCALE: No description available. ,
ASSET_SIZE_TOO_LARGE: No description available. ,
ASSET_DIMENSIONS_OUT_OF_BOUNDS: No description available. ,
ZERO_FACES: No description available. ,
INVALID_FACE_VERTICES: No description available. ,
ZERO_TRAJECTORIES_GENERATED: No description available. ,
TOO_MANY_RIG_POSES: No description available. ,
ASSET_CANNOT_BE_CONVERTED: No description available. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Identifier for the AOA asset conversion job. ,
Format: uuid ,
Required: False ,
}
string ,
outputModelUri:
{
Description: The URI for downloading the generated AOA Model ,
Format: uri ,
Required: False ,
}
string ,
jobStatus:
{
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
assetFileType:
{
Description: The file type of the original 3D asset. Examples include: "ply", "obj", "fbx", "glb", "gltf", etc. ,
Required: False ,
}
string ,
inputAssetUri:
{
Description: The Uri to the Asset to be ingested by the AOA asset conversion service. This asset needs to have been uploaded to the service using an endpoint provided from a call to the GetUploadUri API. ,
Format: uri ,
Required: False ,
}
string ,
accountId:
{
Description: Identifier for the Account owning the asset conversion job. ,
Format: uuid ,
Required: False ,
}
string ,
ingestionConfiguration:
{
Description: Represents an ingestion configuration. ,
Required: False ,
}
{
dimensions:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
boundingBoxCenter:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
gravity:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
keyFrameIndexes:
{
Description: Indices of Key Frames. ,
Required: False ,
}
[
integer ,
]
,
gtTrajectory:
{
Description: Ground truth trajectory. ,
Required: False ,
}
[
{
rotation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
translation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
principalAxis:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
scale:
{
Description: Scale of transformation of asset units into meter space. ,
Format: float ,
Required: True ,
}
number ,
supportingPlane:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
}
,
testTrajectory:
{
Description: Test Trajectory. ,
Required: False ,
}
[
{
rotation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
translation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
IngestionJob_Get (removed)
Description :  Gets the status of a job request.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{accountId}/jobs/{jobId}
{
accountId:
{
Description: Identifier for the Azure Object Anchors account. ,
Format: uuid ,
Required: True ,
}
string ,
jobId:
{
Description: Identifier for the Azure Object Anchors ingestion job. ,
Format: uuid ,
Required: True ,
}
string ,
x-mrc-cv:
{
Description: The client request correlation vector, which should be set to a new value for each request. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. ,
}
string ,
}
,
$schema:
{
Description: Represents the status of an AOA asset conversion job. ,
}
{
clientErrorDetails:
{
Description: Information about the cause of a ClientError JobStatus. ,
Required: False ,
}
string ,
serverErrorDetails:
{
Description: Information about the cause of a ServerError JobStatus. ,
Required: False ,
}
string ,
errorCode:
{
Enum:
{
UNKNOWN: No description available. ,
NO_ERROR: No description available. ,
SERVICE_ERROR: No description available. ,
INVALID_ASSET_URI: No description available. ,
INVALID_JOB_ID: No description available. ,
INVALID_GRAVITY: No description available. ,
INVALID_SCALE: No description available. ,
ASSET_SIZE_TOO_LARGE: No description available. ,
ASSET_DIMENSIONS_OUT_OF_BOUNDS: No description available. ,
ZERO_FACES: No description available. ,
INVALID_FACE_VERTICES: No description available. ,
ZERO_TRAJECTORIES_GENERATED: No description available. ,
TOO_MANY_RIG_POSES: No description available. ,
ASSET_CANNOT_BE_CONVERTED: No description available. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Identifier for the AOA asset conversion job. ,
Format: uuid ,
Required: False ,
}
string ,
outputModelUri:
{
Description: The URI for downloading the generated AOA Model ,
Format: uri ,
Required: False ,
}
string ,
jobStatus:
{
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
assetFileType:
{
Description: The file type of the original 3D asset. Examples include: "ply", "obj", "fbx", "glb", "gltf", etc. ,
Required: False ,
}
string ,
inputAssetUri:
{
Description: The Uri to the Asset to be ingested by the AOA asset conversion service. This asset needs to have been uploaded to the service using an endpoint provided from a call to the GetUploadUri API. ,
Format: uri ,
Required: False ,
}
string ,
accountId:
{
Description: Identifier for the Account owning the asset conversion job. ,
Format: uuid ,
Required: False ,
}
string ,
ingestionConfiguration:
{
Description: Represents an ingestion configuration. ,
Required: False ,
}
{
dimensions:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
boundingBoxCenter:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
gravity:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
keyFrameIndexes:
{
Description: Indices of Key Frames. ,
Required: False ,
}
[
integer ,
]
,
gtTrajectory:
{
Description: Ground truth trajectory. ,
Required: False ,
}
[
{
rotation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
translation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
principalAxis:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
scale:
{
Description: Scale of transformation of asset units into meter space. ,
Format: float ,
Required: True ,
}
number ,
supportingPlane:
{
Required: False ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
}
,
testTrajectory:
{
Description: Test Trajectory. ,
Required: False ,
}
[
{
rotation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
w:
{
Format: float ,
Required: True ,
}
number ,
isIdentity:
{
Required: False ,
}
boolean ,
}
,
translation:
{
Required: True ,
}
{
x:
{
Format: float ,
Required: True ,
}
number ,
y:
{
Format: float ,
Required: True ,
}
number ,
z:
{
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}
BlobUploadEndpoint_Get (removed)
Description :  Gets a blob upload uri.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{accountId}/blobUploadEndpoint
{
accountId:
{
Description: Identifier for the Azure Object Anchors account. ,
Format: uuid ,
Required: True ,
}
string ,
x-mrc-cv:
{
Description: The client request correlation vector, which should be set to a new value for each request. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. ,
}
string ,
}
,
$schema:
{
inputAssetUri:
{
Description: The blob upload URI where a model should be uploaded to the service for ingestion. ,
Format: uri ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Required: False ,
}
string ,
message:
{
Required: False ,
}
string ,
}
,
}