Jump to

• Request
• Response

Read transcript node of the item transcripts

get

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

Read transcript node of the given item transcripts.

Request

Path Parameters

• id: string
  id of the item.
• transcriptId: string
  id of the transcript

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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."
}

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top