IngestManifestFile

  • Article

An IngestManifestFile represents an actual video or audio blob object that will be uploaded as part of bulk ingesting. For more information on bulk ingesting, see Ingesting Assets in Bulk with the REST API. An IngestManifestFile is always associated with an IngestManifest and an IngestManifestAsset.

This topic gives an overview of the IngestManifestFile entity and also demonstrates how to execute various operations with the Media Services REST API.

Important

When accessing entities in Media Services, you must set specific header fields and values in your HTTP requests.
For more information, see Setup for Media Services REST API Development and Connecting to Media Services with the Media Services REST API.

IngestManifestFile Entity Properties

Property Type Description
Id

Read-only. Set by Media Services at creation time.		 Edm.String Unique identifier.
Created

Read-only. Set by Media Services at creation time.		 Edm.DateTime Represents the number of milliseconds since midnight Jan 1, 1970.
LastModified

Read-only. Set by Media Services.		 Edm.DateTime This value is updated by Media Services after any property changes are made. It represents the number of milliseconds since midnight Jan 1, 1970.
Name

Required.		 Edm.String Actual filename that will be uploaded to the blob container referenced by the IngestManifest’s BlobStorageUriForUpload property. Media Services watches for the file upload in that container by name.

The file name must not be empty or white spaces. Unique within the IngestManifest. Maximum length is 4000.
State

Read-only. Set by Media Services.		 Edm.Int32 The current state of the IngestManifestFile. This value can be one of the following:

- Pending = 0: The file has not yet been uploaded in order to complete the asset creation. Media Services is waiting on the file upload.
- Finished = 1: The file upload was detected and the associated asset has been updated.
- Error = 2: An error occurred processing this file. See the ErrorDetails property for error information.
ParentIngestManifestId

Required.		 Edm.String IngestManifest Id of the manifest that contains this file.
ParentIngestManifestAssetId

Required.		 Edm.String IngestManifestAsset Id of the IngestManifestAsset that this file is associated with.
ErrorDetail

Read-only. Set by Media Services.		 Edm.String Details of an errors encountered processing this file.
MimeType

Optional.		 Edm.String Media Services does not inspect any blob that you uploaded, so you must manually set the mime type. For example, "text/plain" or "video/x-ms-wmv" are valid values to use.
IsPrimary

Optional.		 Edm.Boolean Determines if this IngestManifestFile is the primary file in a multi-file Asset.
EncryptionVersion

Optional.		 Edm.String Current supported version for StorageEncryption, CommonEncryption, and EnvelopeEncryption is "1.0".
EncryptionScheme

Optional.		 Edm.String The encryption scheme used for this file. The valid values are: "StorageEncryption", "CommonEncryption", or "EnvelopeEncryption".
IsEncrypted

Optional.		 Edm.Boolean This value should be set to true if this file is stored encrypted.
EncryptionKeyId

Optional.		 Edm.String Encrypted ContentKey Id.
InitializationVector

Optional.		 Edm.String The initialization vector used for storage encryption.

Create an IngestManifestFile

IngestManifestFiles can be created by using an HTTP POST request. You must pass a request body that contains the name of the Name of the new IngestManifestFile along with the ParentIngestManifestId and the ParentIngestManifestAssetId.

Method Request URI HTTP Version
POST https://<accountname>.restv2.<location>.media.azure.net/api/IngestManifestFiles HTTP/1.1

Sample Request

To get the latest x-ms-version:, see Media Services REST.

POST https://<accountname>.restv2.<location>.media.azure.net/api/IngestManifestFiles HTTP/1.1  
Content-Type: application/json;odata=verbose  
Accept: application/json;odata=verbose  
DataServiceVersion: 3.0  
MaxDataServiceVersion: 3.0  
x-ms-version: 2.19  
Authorization: Bearer <token value>  
Host: media.windows.net  
Content-Length: 200  
Expect: 100-continue  
  
{ "Name" : "REST_Example_File.wmv", "ParentIngestManifestId" : "nb:mid:UUID:bfe2d76c-17bd-884a-b9be-21bdfda65984", "ParentIngestManifestAssetId" : "nb:maid:UUID:9c6e7256-fefd-c541-aa69-fd04cf1cc1a6" }

List an IngestManifestFile

IngestManifestFiles can be retrieved using an HTTP GET request. You can request an IngestManifestFile by its Id or request all IngestManifestFiles by omitting the Id.

Method Request URI HTTP Version
GET https://<accountname>.restv2.<location>.media.azure.net/api/IngestManifestFiles HTTP/1.1
GET https://<accountname>.restv2.<location>.media.azure.net/api/IngestManifestFiles(‘IngestManifestFile Id’) HTTP/1.1

Sample Request

To get the latest x-ms-version:, see Media Services REST.

GET https://<accountname>.restv2.<location>.media.azure.net/api/IngestManifestFiles('nb:mfid:UUID:030ef5ef-c5b3-2c4a-86da-217d4d2170de') HTTP/1.1  
Content-Type: application/json;odata=verbose  
Accept: application/json;odata=verbose  
DataServiceVersion: 3.0  
MaxDataServiceVersion: 3.0  
x-ms-version: 2.19  
Authorization: Bearer <token value>  
Host: media.windows.net

Delete an IngestManifestFile

IngestManifestFiles can be deleted by referencing the IngestManifestFile Id value with an HTTP DELETE request.

Method Request URI HTTP Version
DELETE https://<accountname>.restv2.<location>.media.azure.net/api/IngestManifestFiles(‘IngestManifestFile Id’) HTTP/1.1

Sample Request

To get the latest x-ms-version:, see Media Services REST.

DELETE https://<accountname>.restv2.<location>.media.azure.net/api/IngestManifestFiles('nb:mfid:UUID:030ef5ef-c5b3-2c4a-86da-217d4d2170de') HTTP/1.1  
Content-Type: application/json;odata=verbose  
Accept: application/json;odata=verbose  
DataServiceVersion: 3.0  
MaxDataServiceVersion: 3.0  
x-ms-version: 2.19  
Authorization: Bearer <token value>  
Host: media.windows.net  
Content-Length: 0

See Also

AssetFile
IngestManifest
IngestManifestAsset
IngestManifestStatistics
Quotas and Limitations