GET /cxf/pri/v1/capturedassets/{id}

Asset validation

To get the status of the capture, the PRI client will send an HTTP GET request with no payload, including the <id> of the single resource to the URL:

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

Request headers

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

Path parameters

Parameter	Type	Description	Required
`Id`	String	Public unique identifier of the captured asset	Yes

Request body

The request body must be empty.

Success response

An HTTP 200 response occurs when asset validation is successful.

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	Identifier of the source stream where to capture the asset	No
`captureStartDate`	dateTime	The date the CapturedAsset was created `yyyy-MM-ddTHH:mm:ss.SSSZ`	No
`captureEndDate`	dateTime	The date the CapturedAsset was created `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. Valid values are Scheduled, InProgress, Completed, Failed, Cancelled, Expired.	Yes
`providerId`	String	Identifier of the capture requester	No
`deliveryUrl`	String	The delivery URL of the CapturedAsset. For JITP, this is the mezzanine asset URL.	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 that this value must then be supplied as the URL query parameter on all subsequent PURGE requests for the same asset. `metadata` is a container for additional information that is sent from the encoders, such as `ConsumptionUrl_PACKAGINGTYPE` (e.g., `ConsumptionUrl_DASH`). In JITP encoder setup, e.g., VOS360, the packaged asset URLs will be passed via metadata with the convention as explained above.	No, but in the JITP case, the asset URL is required.
`created`	dateTime	The date the CapturedAsset was created `yyyy-MM-ddTHH:mm:ss.SSSZ`	No
`modified`	dateTime	The date the CapturedAsset was last modified `yyyy-MM-ddTHH:mm:ss.SSSZ`	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

Success response body

CODE

{
  "id": "4347",
  "sourceId": "HitiOutput-158635176-53925-1406544832",
  "captureStartDate": "2014-11-05T10:05:53.000Z",
  "captureEndDate": "2014-11-05T10:05:54.000Z",
  "status": "Completed",
  "deliveryURL": "/assets/index-HitiOutput-158635176-53925-1406544832_4347.m3u8",
  "metadata":[{"key":"ConsumptionUrl_HLS","value":"/Content/HLS/LLCU/ltcu_eventp09_eventpr09/index.m3u8"},
       {"key":"ConsumptionUrl_SS","value":"/Content/SS/LLCU/ltcu_eventp09_eventpr09.ism/Manifest"},
 {"key":"ConsumptionUrl_DASH","value":"/Content/DASH/LLCU/ltcu_eventp09_eventpr09/manifest.mpd"}]
}

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 500 :

CODE

{
    "statusCode": "500",
    "statusMessage": "Internal Error ::Parameter sourceId is mandatory"
}