Jump to

• Request
• Response

Bulk Transcript Operations.

post

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

Bulk Transcript operations.
The request body contains transcript operations such as create, update, delete.
The create block of the payload accepts a list of transcript nodes that can be created with node fields - start, end, text
The update block of the payload accepts a list of merge patch documents with fields - id (required) and can contain fields that are mutable - start, end, text
The delete block of the payload accepts a list of nodes to be deleted with fields - id (required). Accepts header Prefer - value respond-async and returns location header with href pointingto the bulk transcript nodes status api with status id of the current job.
This returns response with nodes created in create node with fields id, start, end, text and additionally links to the transcript node if requested, nodes updated and affected in update bucket with fields - that are updated as part of the request and additionally links to the node if requested.
Throws exceptions with 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-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.

Header Parameters

• Prefer(optional): string
  This parameter is used to control the interaction type (synchronous/asynchronous) of the request. If the header is provided with value respond-async, it indicates that asynchronous interaction is preferred. Otherwise, synchronous interaction is preferred. Asynchronous request is responded with 202 status with a status link in the location header. Synchronous request is responded with 200 along with response body.

  Allowed Values: [ "respond-async" ]
• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Bulk transcript operations.

Root Schema : BulkTranscriptOperations

Type: object

Transcript Bulk Operations

Show Source

• create(optional): array create
• delete(optional): array delete
• links(optional): array links
  Read Only: true

  links to the bulk node operation resource
• update(optional): array update

{
    "type":"object",
    "properties":{
        "create":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Videotranscript"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"links to the bulk node operation resource",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Transcript Bulk Operations"
}

Nested Schema : create

Type: array

Show Source

• Array of: object Videotranscript
  Video transcript

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Videotranscript"
    }
}

Nested Schema : delete

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Read Only: true

links to the bulk node operation resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links to the bulk node operation resource",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : update

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

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

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

202 Response

Accepted.

Body ()

Root Schema : BulkTranscriptOperations

Type: object

Transcript Bulk Operations

Show Source

• create(optional): array create
• delete(optional): array delete
• links(optional): array links
  Read Only: true

  links to the bulk node operation resource
• update(optional): array update

{
    "type":"object",
    "properties":{
        "create":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Videotranscript"
            }
        },
        "update":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        },
        "delete":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "description":"links to the bulk node operation resource",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Transcript Bulk Operations"
}

Nested Schema : create

Type: array

Show Source

• Array of: object Videotranscript
  Video transcript

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Videotranscript"
    }
}

Nested Schema : delete

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Read Only: true

links to the bulk node operation resource

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links to the bulk node operation resource",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : update

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

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

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

409 Response

Conflict.

500 Response

Internal server error.

Back to Top