Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
REST API Functions

REST API Functions

 

Updated: July 1, 2015

The following functions support the Microsoft Azure Media Services entities by performing various tasks such as canceling jobs, retrieving protection keys, and so on.

CancelJob. Takes the following parameter: jobid of Edm.String type.

GetProtectionKeyId. Takes the following parameter: contentKeyType of Edm.Int32 type. Returns Edm.String.

GetProtectionKey. Takes the following parameter: protectionKeyId of Edm.String type. Returns Edm.String.

CreateFileInfos. Takes the following parameter: assetid of Edm.String type.

RebindContentKey. Takes the following parameters: id of Edm.String type, x509Certificate of Edm.String type. Returns Edm.String.

Publish. Takes the following parameter: assetid of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset type.

GetKeyDeliveryUrl. Takes the following parameters: contentKey of Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey type, keyDeliveryType of Edm.String type. Returns Edm.Int32.

Start. Takes the following parameter: streamingEndpoint of Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint type.

Start. Takes the following parameter: channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.

Start. Takes the following parameter: program of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program type.

Stop. Takes the following parameter: streamingEndpoint of Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint type.

Stop. Takes the following parameter: channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.

Stop. Takes the following parameter: program of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program type.

Scale. Takes the following parameters: streamingEndpoint of Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint type, scaleUnits of Edm.String type.

ShowSlate. Takes the following parameters: channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type, duration of Edm.Time type, assetId of Edm.String type.

StartAdvertisement. Takes the following parameters: channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type, duration of Edm.Time type, cueId of Edm.Int32 type, showSlate of Edm.Boolean type.

HideSlate. Takes the following parameter: channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.

EndAdvertisement. Takes the following parameters: channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type, cueId of Edm.Int32 type.

Reset. Takes the following parameter: channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.

System_CAPS_importantImportant

When working with the Media Services REST API, the following considerations apply:

The rest of the topic shows a few examples of how to call functions using REST.

Running Jobs can be canceled by calling CancelJob and passing in the Job Id of a currently running Job.

Method

Request URI

HTTP Version

GET

https://media.windows.net/API/CancelJob?jobid='URL-encodedvalue'

HTTP/1.1

System_CAPS_importantImportant

After successfully connecting to https://media.windows.net, you will receive a 301 redirect specifying another Media Services URI. You must make subsequent calls to the new URI.

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

GET https://media.windows.net/API/CancelJob?jobid='nb%3ajid%3aUUID%3a9e9533ba-2b9b-fa4c-a33d-73eebd49039b' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.11
Authorization: Bearer http%3a%2f%2fschemas.xmlsoap.org%2fws%2f2005%2f05%2fidentity%2fclaims%2fnameidentifier=youraccountname&urn%3aSubscriptionId=2f84471d-b1ae-4e75-aa09-010f0fc0cf5b&http%3a%2f%2fschemas.microsoft.com%2faccesscontrolservice%2f2010%2f07%2fclaims%2fidentityprovider=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&Audience=urn%3aWindowsAzureMediaServices&ExpiresOn=1336908753&Issuer=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&HMACSHA256=kolAgnFfbQIeRv4lWxKSFa4USyjWXRm15Kd%2bNd5g8eA%3d
Host: media.windows.net

A File entity is created using the CreateFileInfos function and passing in the Asset Id that is associated with the media file you uploaded into blob storage. For more information, see Upload a file to blob storage.

Method

Request URI

HTTP Version

GET

https://media.windows.net/api/CreateFileInfos?assetid='URL-encodedvalue'

HTTP/1.1

System_CAPS_importantImportant

After successfully connecting to https://media.windows.net, you will receive a 301 redirect specifying another Media Services URI. You must make subsequent calls to the new URI.

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

GET https://media.windows.net/api/CreateFileInfos?assetid='nb%3Acid%3AUUID%3Ac80d312d-7cb1-44aa-bb23-2c35d10c44bd' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.11
Authorization: Bearer http%3a%2f%2fschemas.xmlsoap.org%2fws%2f2005%2f05%2fidentity%2fclaims%2fnameidentifier=youraccountname&urn%3aSubscriptionId=2f84471d-b1ae-4e75-aa09-010f0fc0cf5b&http%3a%2f%2fschemas.microsoft.com%2faccesscontrolservice%2f2010%2f07%2fclaims%2fidentityprovider=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&Audience=urn%3aWindowsAzureMediaServices&ExpiresOn=1336547485&Issuer=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&HMACSHA256=ISzXspEIbgWifYYXqiPK1vo3%2bDHnTsX85umNxRjD3kQ%3d
Host: media.windows.net
Content-Length: 0

The GetProtectionKeyId function retrieves an X.509 certificate thumbprint that is used to ensure that you have the correct certificate installed on your machine when encrypting your user-defined content key. The list of possible values for the contentKeyType parameter map to the ContentKeyType enumeration values on the ContentKey entity. For more information, see ContentKey Entity Properties.

Method

Request URI

HTTP Version

GET

https://media.windows.net/API/GetProtectionKeyId?contentKeyType=value

HTTP/1.1

System_CAPS_importantImportant

After successfully connecting to https://media.windows.net, you will receive a 301 redirect specifying another Media Services URI. You must make subsequent calls to the new URI.

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

GET https://media.windows.net/API/GetProtectionKeyId?contentKeyType=1 HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.11
Authorization: Bearer http%3a%2f%2fschemas.xmlsoap.org%2fws%2f2005%2f05%2fidentity%2fclaims%2fnameidentifier=youraccountname&urn%3aSubscriptionId=2f84471d-b1ae-4e75-aa09-010f0fc0cf5b&http%3a%2f%2fschemas.microsoft.com%2faccesscontrolservice%2f2010%2f07%2fclaims%2fidentityprovider=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&Audience=urn%3aWindowsAzureMediaServices&ExpiresOn=1335862109&Issuer=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&HMACSHA256=ErOpftkPKjzX3bdYcEUZTK9yAwKIDc20y0kxEBZLvCk%3d
Host: media.windows.net

GetProtectionKey retrieves the specific X.509 certificate that should be used to encrypt your user-defined content key.

Method

Request URI

HTTP Version

GET

https://media.windows.net/API/GetProtectionKey?ProtectionKeyId='value'

HTTP/1.1

System_CAPS_importantImportant

After successfully connecting to https://media.windows.net, you will receive a 301 redirect specifying another Media Services URI. You must make subsequent calls to the new URI.

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

GET https://media.windows.net/API/GetProtectionKey?ProtectionKeyId='B2FE17BEF56FFCB9A3FC4267D0F2AFE25CD2DE22' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.11
Authorization: Bearer http%3a%2f%2fschemas.xmlsoap.org%2fws%2f2005%2f05%2fidentity%2fclaims%2fnameidentifier=youraccountname&urn%3aSubscriptionId=2f84471d-b1ae-4e75-aa09-010f0fc0cf5b&http%3a%2f%2fschemas.microsoft.com%2faccesscontrolservice%2f2010%2f07%2fclaims%2fidentityprovider=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&Audience=urn%3aWindowsAzureMediaServices&ExpiresOn=1335935139&Issuer=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&HMACSHA256=s2dI0Ulkutx%2b5pTL0QGRnPQEv1Ogwz%2ff2SHRWK8bmyw%3d
Host: media.windows.net

If you want to retrieve your encrypted content key back from Media Services, then call RebindContentKey and pass in your ContentKey Id and the X.509 certificate (with only the public key) that was used to encrypt the clear storage encryption/common protection content keys. If you call RebindContentKey and pass in an empty string to the x509Certificate parameter, then your content key is base64-encoded and returned in clear.

Method

Request URI

HTTP Version

GET

https://media.windows.net/API/RebindContentKey?id='contentkeyid'&x509Certificate='URL-encodedvalue'

HTTP/1.1

System_CAPS_importantImportant

After successfully connecting to https://media.windows.net, you will receive a 301 redirect specifying another Media Services URI. You must make subsequent calls to the new URI.

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

GET https://media.windows.net/API/RebindContentKey?id='nb%3akid%3aUUID%3a2eeba14e-613e-4af7-a926-413372cca8d5'&x509Certificate='' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.11
Authorization: Bearer http%3a%2f%2fschemas.xmlsoap.org%2fws%2f2005%2f05%2fidentity%2fclaims%2fnameidentifier=youraccountname&urn%3aSubscriptionId=2f84471d-b1ae-4e75-aa09-010f0fc0cf5b&http%3a%2f%2fschemas.microsoft.com%2faccesscontrolservice%2f2010%2f07%2fclaims%2fidentityprovider=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&Audience=urn%3aWindowsAzureMediaServices&ExpiresOn=1337251388&Issuer=https%3a%2f%2fwamsprodglobal001acs.accesscontrol.windows.net%2f&HMACSHA256=LdLXZO6LQ5vhvWfc%2bkL%2fYz%2fc3ZPf2v30h0LCCn2Kdis%3d
Host: media.windows.net
Show:
© 2015 Microsoft