Jump to

• Request
• Response

Creates a transcript with the given information in the payload.

post

/content/management/api/v1.1/items/{id}/metadata/{metadataType}

Create a transcript node. The request body should contain (required fields) start, end, text.Throws exceptions with error code
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-TRANSCRIPT-022004 if the fields are incorrect
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/json

Path Parameters

• id: string
  id of the item.
• metadataType: string
  type of the metadata. This currently accepts exif,transcripts.

  Default Value: transcripts

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

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Creates an item transcript node with the given information in the payload. The fields id, links will be ignored even if given in the payload.

Root Schema : Videotranscript

Type: object

Video transcript

Show Source

• end(optional): string
  End of each transcript node.
• id(optional): string
  Id of each transcript node.
• links(optional): array links
  Links
• start(optional): string
  Start of each transcript node.
• text(optional): string
  Text of each transcript node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of each transcript node."
        },
        "start":{
            "type":"string",
            "description":"Start of each transcript node."
        },
        "end":{
            "type":"string",
            "description":"End of each transcript node."
        },
        "text":{
            "type":"string",
            "description":"Text of each transcript node."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Video transcript"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Back to Top

Response

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.

Back to Top