Skip to main content

List files by groups

GET 
/bv/cms/v1/library/files

List File in Library by groups. By default, it will return all files that have been uploaded successfully.

Request​

Query Parameters

    current_page int32

    Input only. Indicates the current page to show. Default: 1

    items_per_page int32

    Input only. Indicates the number of items to show per page. Default: 10.

    type stringrequired

    Possible values: [FILE_TYPE_VIDEO, FILE_TYPE_IMAGE, FILE_TYPE_SUBTITLE, FILE_TYPE_DOCUMENT, FILE_TYPE_WEB_LINK, FILE_TYPE_AUDIO]

    Required. Filter by the type of file

    filter.name string

    Filter by the name of file

    filter.subtitle_formats string[]

    Possible values: [SUBTITLE_FORMAT_SRT, SUBTITLE_FORMAT_VTT]

    Filter by the subtitle type of Video

    filter.all boolean

    Filter by the all of file.

    filter.group_ids string[]

    Filter by the groups

Header Parameters

    x-bv-org-id stringrequired

    To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Responses​

A successful response.

Schema
    files object[]
  • Array [
    • id string

    Output only. The unique id of the file.

    type string

    Possible values: [FILE_TYPE_VIDEO, FILE_TYPE_IMAGE, FILE_TYPE_SUBTITLE, FILE_TYPE_DOCUMENT, FILE_TYPE_WEB_LINK, FILE_TYPE_AUDIO]

    Input only. The type of the file.

    name string

    Input only. The name of the file.

    size int64

    Input only. The size of the file in bytes.

    uri string

    Output only. The uri of the file.

    source stringrequired

    Possible values: [FILE_SOURCE_LIVE_EVENT, FILE_SOURCE_UPLOAD_IN_LIBRARY, FILE_SOURCE_ADD_VOD, FILE_SOURCE_CLOUD_STORAGE_AWS, FILE_SOURCE_STT, FILE_SOURCE_ADD_AOD, FILE_SOURCE_AISK, FILE_SOURCE_GOOGLE_DRIVE, FILE_SOURCE_GOOGLE_CALENDAR, FILE_SOURCE_HIGHLIGHT, FILE_SOURCE_TRANSLATE, FILE_SOURCE_LIVE_CLIP]

    Required. The source of the file, only for display.

    attrs object
    property name* string
    has_subtitle Output Only. Indicate the video has subtitle or not when the file type is `FILE_TYPE_VIDEO` (boolean)
    subtitles object[]
  • Array [
    • id string

    The unique id of the subtitle.

    library_id string

    The unique id of the library subtitle file.

    name string

    The name of the subtitle file.

    code string

    The language code of the subtitle file. Follow RFC 5646 (shortest ISO 639 code).

    display string

    The display name of the subtitle file.

  • ]
    • status string

    Possible values: [FILE_STATUS_SUCCEED, FILE_STATUS_PROGRESSING, FILE_STATUS_FAILED]

    Output Only. The file status.

    permission object
    default_access_role stringrequired

    Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

    assignments object[]
  • Array [
    • id stringrequired

    Required. Output Only. if the assigned_type is ASSIGNED_TYPE_USER, the id is user id. if the assigned_type is ASSIGNED_TYPE_GROUP, the id is group id.

    email string

    Output Only. It will return if the assigned_type matches ASSIGNED_TYPE_USER.

    name string

    Output Only. The name of user or group.

    assigned_type Required. Output Only. It indicates the assigned type is user or group. It is not accept the `ASSIGNED_TYPE_OWNER` (string)required

    Possible values: [ASSIGNED_TYPE_USER, ASSIGNED_TYPE_GROUP]

    access_role Required. Output Only. It indicates access role. It is not accept the `ACCESS_ROLE_DENY` (string)required

    Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

  • ]
    • summary object

    Deprecated. Do not use. Use FetchSummary API instead.

    content string

    The content of summary.

    status string

    Possible values: [SUMMARY_STATUS_WAITING, SUMMARY_STATUS_PROCESSING, SUMMARY_STATUS_READY, SUMMARY_STATUS_FAILED]

    The status of summary.

    error_infos object[]

    Output only. Optional. A list of messages that carry the error infos when vod encoding is failed.

  • Array [
    • reason string

    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

    domain string

    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

    metadata object

    Additional structured details about this error.

    Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

    property name* string
  • ]
    • metadata object

    Optional. The metadata of the file.

    short_description string

    Optional. The short description of the file.

    long_description string

    Optional. The long description of the file.

    labels string[]

    Optional. The labels of the file.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

  • ]
    • pagination object
    total_items int32

    Output only. The total numbers of the list in the current pagination.

    items_per_page int32

    Output only. The number of items per page in the current pagination.

    current_page int32

    Output only. The current page in the current pagination.

Loading...