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

Asset update

The PRI client will send a PUT request including the <id> of an existing captured asset to the following URL:

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

The PRI server must support partial updates whereby only the fields that need to be changed are included, and any unspecified fields retain the values provided in the preceding POST or PUT requests. Depending upon encoder capabilities, some updates may be refused, for example modification of captureStartDate once the asset transfer to disk has begun.

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
`name`	String	The friendly name of the CapturedAsset, for display purposes	No
`captureStartDate`	dateTime	UTC timestamp of the start of the start-over session `yyyy-MM-ddTHH:mm:ss.SSSZ`	Yes
`captureEndDate`	dateTime	UTC timestamp of the start of the start-over session `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, 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 PURGE requests for the same asset.	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 a PUT JSON payload:

CODE

{
    "captureStartDate": "2015-10-05T12:47:45.000Z",
    "captureEndDate": "2015-10-05T12:47:46.000Z"
}

Success response

An HTTP 200 response occurs when captured asset is updated.

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

CODE

{
    "statusCode": "501",
    "statusMessage": "Internal Error ::Method Not Implemented"
}