Patches a transcript node.
patch
/content/management/api/v1.1/items/{id}/metadata/transcripts/{transcriptId}
Patch a transcript node. The request body can contain fields that are mutable - start, end, text. Any other fields passed will be ignored (read-only). This patches the transcript node with requested data and returns only the updated fields. This response can be customised by using optional links parameter. Throws exceptions with these error codes:
CEC-CONTENT-TRANSCRIPT-022001 if the file type is not supported for transcript generation
CEC-CONTENT-TRANSCRIPT-022002 if improper transcript duration is given in payload
CEC-CONTENT-TRANSCRIPT-022003 if invalid start/end time format is given in payload
CEC-CONTENT-001004 if the user does not have the enterprise user role or if the user does not have at least contributor role on repository
CEC-CONTENT-TRANSCRIPT-022001 if the file type is not supported for transcript generation
CEC-CONTENT-TRANSCRIPT-022002 if improper transcript duration is given in payload
CEC-CONTENT-TRANSCRIPT-022003 if invalid start/end time format is given in payload
CEC-CONTENT-001004 if the user does not have the enterprise user role or if the user does not have at least contributor role on repository
Request
Supported Media Types
- application/merge-patch+json
- application/json
Path Parameters
-
id: string
id of the item.
-
transcriptId: string
id of the transcript
Query Parameters
-
links(optional): string
This is an optional parameter. This parameter accepts a comma-separated list of links to be returned in the response. Possible values are: self, canonical
Patches a transcript node with the given information in the JSON merge patch document.
The examples below describe the minimal update possible on a per field basis. Any combination between these examples below are valid and they should be used to patch only the desired fields i.e. start, end, text. Any other field like id, links are read-only and ignored in the request.
Example:
```{ "text" : "this is the updated transcript" }```
This payload will replace the text of the transcript node.
Example:
```{ "start" : null }```
This payload will ignore the start of the transcript node since the start time cannot be null. Similar is the case with end time and text
Example:
```{ "start" : "" }```
This payload will throw the exception since the start time cannot be empty. Similar is the case with end time.
The examples below describe the minimal update possible on a per field basis. Any combination between these examples below are valid and they should be used to patch only the desired fields i.e. start, end, text. Any other field like id, links are read-only and ignored in the request.
Example:
```{ "text" : "this is the updated transcript" }```
This payload will replace the text of the transcript node.
Example:
```{ "start" : null }```
This payload will ignore the start of the transcript node since the start time cannot be null. Similar is the case with end time and text
Example:
```{ "start" : "" }```
This payload will throw the exception since the start time cannot be empty. Similar is the case with end time.
Nested Schema : additionalProperties
Type:
objectResponse
Supported Media Types
- application/json
200 Response
OK.
204 Response
No content.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.