POST /cxf/pri/v1/capturedassets

Asset capture

The PRI client will send an HTTP POST request with a payload including all mandatory captured requests fields (in particular the asset identifier (id), channel identifier (source id), event start and end dates) to the following URL:

http://<server>:<port>/<relative_path>/cxf/pri/v1/capturedassets

Request headers

Header	Type	Description	Required value
Accept	String	application/json	Yes
Content-Type	String	application/json	Yes

Query parameters

The query parameters must be empty.

Body

Attribute	Type	Description	Always present
`id`	String	Public unique identifier of the captured asset	Yes
`name`	String	The friendly name of the CapturedAsset, for display purposes	No
`sourceId`	String	`SourceId` represents the identifier of the live streams against which recordings will happen.	Yes
`captureStartDate`	dateTime	UTC timestamp of the start of the capture. `yyyy-MM-ddTHH:mm:ss.SSSZ`	Yes
`captureEndDate`	dateTime	UTC timestamp of the end of the capture. `yyyy-MM-ddTHH:mm:ss.SSSZ`	Yes
`priority`	Integer	The priority of the CapturedAsset, 1 highest to 5 lowest	No
`providerId`	String	Identifier of the capture requester	No
`metadata`	KeyValuePair	The metadata of the CapturedAsset `metadadata` is a container for additional information that is sent from the encoders.	No
`drm`	Array	Provides the DRM details to be used to secure the playable packaged asset for each of the packaging formats. Encoder dependent – if the encoder has its own independent configuration for defining DRM IDs (normally identical to the live streams), this object does not need to be provided.	No

An example of POST JSON payload:

CODE

{
 "id": "4347",
 "sourceId": "HitiOutput-158635176-53925-1406544832",
 "captureStartDate": "2014-11-05T09:00:00.000Z",
 "captureEndDate": "2014-11-05T09:20:00.000Z",
 "metadata":[{"key":"destinationUri","value":"sample destination uri"}]
}

An example of POST JSON payload with DRM details:

CODE

{
   "id": "4347",
   "sourceId": "HitiOutput-158635176-53925-1406544832",
   "captureStartDate": "2014-11-05T09:00:00.000Z",  
   "captureEndDate": "2014-11-05T09:20:00.000Z",
   "Drm":[
      {
         "drmId":"123",
         "packagingFormat":"HLS_2"
      },
      {
         "drmId":"456",
         "packagingFormat":"SS_2"
      }
   ],
   "metadata":[
      {
         "key":"destinationUri",
         "value":"sample destination uri"
      }
   ]
}

"metadata" is dynamic and can include other important details.

Success response

An HTTP 201 response occurs when the captured asset is created.

Parameter	Type	Description	Always present
`id`	String	Public unique identifier of the captured asset	Yes
`name`	String	The friendly name of the CapturedAsset, for display purposes	No
`sourceId`	String	`SourceId` represents the identifier of the live streams against which recordings will happen.	No
`captureStartDate`	dateTime	UTC timestamp of the start of the start-over session `yyyy-MM-ddTHH:mm:ss.SSSZ`	No
`captureEndDate`	dateTime	UTC timestamp of the start of the start-over session `yyyy-MM-ddTHH:mm:ss.SSSZ`	No
`priority`	Integer	The priority of the CapturedAsset, 1 highest to 5 lowest	No
`status`	Enum	The status of the CapturedAsset. The status is set by the recorder and cannot be set by a client request.	Yes
`providerId`	String	Identifier of the capture requester	No
`deliveryURL`	String	The delivery URL of the CapturedAsset. Access to the asset via this URL can only be guaranteed after the captured asset status is "Completed".	Yes
`metadata`	KeyValuePair	The metadata of the CapturedAsset, e.g.: <metadata> <key>ConsumptionUrl_DASH</key> <value>/Content/DASH/LLCU/4sat/ltcu_LYS000009514/manifest.mpd</value> </metadata> The PRI server (or adaptor) may supply `AssetRelativePath` here to indicate the additional part of the path needed to access the capture asset, and this value must then be supplied as the URL query parameter on all subsequent GET and PURGE requests for the same asset.	No
`created`	dateTime	The date when the request to capture the asset was accepted by the PRI server	No
`Drm`	DrmTOType	Provides the DRM details to be used to secure the playable packaged asset for each of the packaging formats. Encoder dependent – if the encoder has its own independent configuration for defining DRM IDs (normally identical to the live streams), this object does not need to be provided.	NO

An example of POST success response payload with DRM details:

CODE

{
   "id": "4347",
   "sourceId": "HitiOutput-158635176-53925-1406544832",
   "captureStartDate": "2014-11-05T09:00:00.000Z",  
   "captureEndDate": "2014-11-05T09:20:00.000Z", 
   "status": "Scheduled",
   "deliveryURL": "https://123.125.186.12/assets/index-4357.m3u8",
   "metadata": [
       {
         "key":"destinationUri"
         "value":"/HitiOutput-158635176-53925-1406544832"
       }
   ],
   "created": "2014-11-06T14:39:57.007Z",
   "Drm":[
      {
         "drmId":"123",
         "packagingFormat":"HLS_2"
      },
      {
         "drmId":"456",
         "packagingFormat":"SS_2"
      }
   ]
}

Error response

An HTTP 400 response occurs for a bad request.

An HTTP 500 response occurs when there is a PRI Adapter internal error (e.g., mandatory parameters are unspecified).

An HTTP 501 response occurs for method not implemented.

An HTTP 504 response occurs for encoder timeout.

An example error response for HTTP error code 504:

CODE

{
    "statusCode": "504",
    "statusMessage": "Internal Error ::Connection timed out to the Envivio Halo encoder::Connection refused"
}