Initiate file upload

POST 
/bv/cms/v1/library/files:upload

Begins a file upload session. After uploading the file data, invoke complete file upload API to complete the process.

---

Required field(s):

• file

---

Request

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.

application/json

Body

required

file objectrequired

Required.

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.

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

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.

Responses

200

A successful response.

application/json

Schema

Schema

file object

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 Get Summary API instead.

content string

The content of summary.

status string

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

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.

upload_data object
id The upload id of the file (string)
parts object[]
Array [
part_number int32
This attribute represents the sequential number assigned to each part of the file.
presigned_url string
The presigned URL allows the user to directly upload a file part to the file resource.
]

Example (from schema)

{
  "file": {
    "attrs": {},
    "created_at": "2023-05-26T06:08:30.661Z",
    "id": "827ec0cb-9943-4cb4-9f1f-da0b395b0ccf",
    "name": "video.mp4",
    "permission": {
      "assignments": [
        {
          "access_role": "ACCESS_ROLE_SUPER_EDITOR",
          "assigned_type": "ASSIGNED_TYPE_OWNER",
          "email": "",
          "id": "",
          "name": ""
        }
      ],
      "default_access_role": "ACCESS_ROLE_DENY"
    },
    "size": "260543670",
    "source": "FILE_SOURCE_UPLOAD_IN_LIBRARY",
    "type": "FILE_TYPE_VIDEO",
    "updated_at": "2023-05-26T06:08:30.661Z",
    "uri": ""
  },
  "upload_data": {
    "id": "OszKAZjpmN.42t7e_Sm2BD1LzTu_gODwzPS2pm1fgVnR54LgiptLMgpdmQTBkH2XyoAtHHR4bIiFiRay2sm3eL678r2uJ0DvFl.4ZpXw8F4VF_BfnDP4QDPvq4oe.huduDRIYcpisZGqCN3BiH5wSgiKoSZ7bpfmx3VoNLgS6w4-",
    "parts": [
      {
        "part_number": 1,
        "presigned_url": "https://kks-platform-orbit-content-store-dev.s3.ap-northeast-1.amazonaws.com/42f6c33e-f632-44e5-8042-05abb5fa2223/video/ad84dc85-73a1-4588-8a29-378923cdd60b/ad84dc85-73a1-4588-8a29-378923cdd60b.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAX2E7FTDHJGZCLJ4B%2F20230526%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Date=20230526T060830Z&X-Amz-Expires=21600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEO7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDmFwLW5vcnRoZWFzdC0xIkcwRQIgEpY1u74QZGxXnuHTxSDLE%2BLRnt5hgxVFNOPWMUZqGUQCIQD4KBEPxj6p7Ggl9mZwahh3xq7s7Bo2iYcOi2V8uZu45yqCBQgnEAAaDDUzNzIwNDcyNTk2NiIM8VxlcmgzwP5kqkH3Kt8E2sgO3hqvjB7%2FyrLFfOvh6HSk8IAH35Q13xP9fvOD45CUY5j7uP6ebvvmDpTZK4vqa1sN5%2Bd5wLfg81oAzi%2F%2FDdI6mrPuBFhs%2Bz6OAJhOY6vUkHbtKa%2BpVdMDKilEai8ObyvCXNPpzu9zkuUH1DwKX8duVXCoonbTQGP2sCNiMnuJ64j56cHb35p0Ad8O17SGk%2Fmc%2FpludvXZwFRFmRInvVUQoeU2bof3maMuOODTo3HRfrWABH4P8IkNYeipuFZDkYBJfQSgg4hqtEqV8BF0AFKxPOieannxJaBs%2BCTdW1mweo%2F9JYryeYJiQLfcW7SlVdkp0qeR%2FbDxVwLM4q5kB17HNyKgpHshL8YS2B%2F3nSZnFYYan2y94r0Hknsjv3zyoj8JbVaJHtADOZq%2F59HUQKTz9Ikp7E0SftFvM00NAD3UCOfo6FYKwYtvREUXqfJxf4DMKx0yVY2DYGZ%2FZ2hR2VTQdLuLYajcg%2BY9IYZsvEyU5YS%2FTHnMmMK3ZqOPVW47tPZfNwu4SlM%2BDc5eMbBMBU8LTVcS2CINffdc2R0dCy8zFf0Mrno1jUbLb4oCCAlv8gFgOnvBspcnCGRUaoI3%2F6TYEDadEgV9oI%2FcpLo41cF0qSVQhmgGWmBaX8GnIW25I1pBOvaybJWh7rm9YegjsmZLwbm21FGhsX2lOX2YObe5wqw2Vo%2FJbmCAZ7wrSLIa8UXmAVM9tx83AZH2b3tXOp7lPJHy5yOBx2COqRGbjy%2B5GC8rx%2BVR%2FTb6YXQ0VH5KYIXEf2vUSVSCDbRA1g64iUFcO3tu%2BADHQSVpIfB2pjDmlMGjBjqaAb%2BKJSsm5ccrrGQgHMJbmPiqn0g4GEvFxDm9IVN8YDjmtnqb5T8uGcXuDvdLjlJ9YAJaMBazEaehj2oXlZfPdHzYgH2ypTEgtXsWEZBF%2BwpUqEAzIgkHWKnpePwMC73Jo%2BujsmTckMsKtsURuj4%2B7yfsXbg74%2By%2Fdm09%2BalelD6TSr43yGCh3MJK5EfRljugsOYy05%2BfqMlD2q8%3D&X-Amz-SignedHeaders=host&partNumber=1&uploadId=OszKAZjpmN.42t7e_Sm2BD1LzTu_gODwzPS2pm1fgVnR54LgiptLMgpdmQTBkH2XyoAtHHR4bIiFiRay2sm3eL678r2uJ0DvFl.4ZpXw8F4VF_BfnDP4QDPvq4oe.huduDRIYcpisZGqCN3BiH5wSgiKoSZ7bpfmx3VoNLgS6w4-&x-id=UploadPart&X-Amz-Signature=0305cb425034fb0bcf7f4fe4b9763feb85af6d2941fa2816e7473d382c7e6f0a"
      },
      {
        "part_number": 2,
        "presigned_url": "https://kks-platform-orbit-content-store-dev.s3.ap-northeast-1.amazonaws.com/42f6c33e-f632-44e5-8042-05abb5fa2223/video/ad84dc85-73a1-4588-8a29-378923cdd60b/ad84dc85-73a1-4588-8a29-378923cdd60b.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAX2E7FTDHJGZCLJ4B%2F20230526%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Date=20230526T060830Z&X-Amz-Expires=21600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEO7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDmFwLW5vcnRoZWFzdC0xIkcwRQIgEpY1u74QZGxXnuHTxSDLE%2BLRnt5hgxVFNOPWMUZqGUQCIQD4KBEPxj6p7Ggl9mZwahh3xq7s7Bo2iYcOi2V8uZu45yqCBQgnEAAaDDUzNzIwNDcyNTk2NiIM8VxlcmgzwP5kqkH3Kt8E2sgO3hqvjB7%2FyrLFfOvh6HSk8IAH35Q13xP9fvOD45CUY5j7uP6ebvvmDpTZK4vqa1sN5%2Bd5wLfg81oAzi%2F%2FDdI6mrPuBFhs%2Bz6OAJhOY6vUkHbtKa%2BpVdMDKilEai8ObyvCXNPpzu9zkuUH1DwKX8duVXCoonbTQGP2sCNiMnuJ64j56cHb35p0Ad8O17SGk%2Fmc%2FpludvXZwFRFmRInvVUQoeU2bof3maMuOODTo3HRfrWABH4P8IkNYeipuFZDkYBJfQSgg4hqtEqV8BF0AFKxPOieannxJaBs%2BCTdW1mweo%2F9JYryeYJiQLfcW7SlVdkp0qeR%2FbDxVwLM4q5kB17HNyKgpHshL8YS2B%2F3nSZnFYYan2y94r0Hknsjv3zyoj8JbVaJHtADOZq%2F59HUQKTz9Ikp7E0SftFvM00NAD3UCOfo6FYKwYtvREUXqfJxf4DMKx0yVY2DYGZ%2FZ2hR2VTQdLuLYajcg%2BY9IYZsvEyU5YS%2FTHnMmMK3ZqOPVW47tPZfNwu4SlM%2BDc5eMbBMBU8LTVcS2CINffdc2R0dCy8zFf0Mrno1jUbLb4oCCAlv8gFgOnvBspcnCGRUaoI3%2F6TYEDadEgV9oI%2FcpLo41cF0qSVQhmgGWmBaX8GnIW25I1pBOvaybJWh7rm9YegjsmZLwbm21FGhsX2lOX2YObe5wqw2Vo%2FJbmCAZ7wrSLIa8UXmAVM9tx83AZH2b3tXOp7lPJHy5yOBx2COqRGbjy%2B5GC8rx%2BVR%2FTb6YXQ0VH5KYIXEf2vUSVSCDbRA1g64iUFcO3tu%2BADHQSVpIfB2pjDmlMGjBjqaAb%2BKJSsm5ccrrGQgHMJbmPiqn0g4GEvFxDm9IVN8YDjmtnqb5T8uGcXuDvdLjlJ9YAJaMBazEaehj2oXlZfPdHzYgH2ypTEgtXsWEZBF%2BwpUqEAzIgkHWKnpePwMC73Jo%2BujsmTckMsKtsURuj4%2B7yfsXbg74%2By%2Fdm09%2BalelD6TSr43yGCh3MJK5EfRljugsOYy05%2BfqMlD2q8%3D&X-Amz-SignedHeaders=host&partNumber=2&uploadId=OszKAZjpmN.42t7e_Sm2BD1LzTu_gODwzPS2pm1fgVnR54LgiptLMgpdmQTBkH2XyoAtHHR4bIiFiRay2sm3eL678r2uJ0DvFl.4ZpXw8F4VF_BfnDP4QDPvq4oe.huduDRIYcpisZGqCN3BiH5wSgiKoSZ7bpfmx3VoNLgS6w4-&x-id=UploadPart&X-Amz-Signature=78f7084588e23379e67aa62c8934e9b8060241548d17a49b7af58c924b6cbb80"
      },
      {
        "part_number": 3,
        "presigned_url": "https://kks-platform-orbit-content-store-dev.s3.ap-northeast-1.amazonaws.com/42f6c33e-f632-44e5-8042-05abb5fa2223/video/ad84dc85-73a1-4588-8a29-378923cdd60b/ad84dc85-73a1-4588-8a29-378923cdd60b.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAX2E7FTDHJGZCLJ4B%2F20230526%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Date=20230526T060830Z&X-Amz-Expires=21600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEO7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDmFwLW5vcnRoZWFzdC0xIkcwRQIgEpY1u74QZGxXnuHTxSDLE%2BLRnt5hgxVFNOPWMUZqGUQCIQD4KBEPxj6p7Ggl9mZwahh3xq7s7Bo2iYcOi2V8uZu45yqCBQgnEAAaDDUzNzIwNDcyNTk2NiIM8VxlcmgzwP5kqkH3Kt8E2sgO3hqvjB7%2FyrLFfOvh6HSk8IAH35Q13xP9fvOD45CUY5j7uP6ebvvmDpTZK4vqa1sN5%2Bd5wLfg81oAzi%2F%2FDdI6mrPuBFhs%2Bz6OAJhOY6vUkHbtKa%2BpVdMDKilEai8ObyvCXNPpzu9zkuUH1DwKX8duVXCoonbTQGP2sCNiMnuJ64j56cHb35p0Ad8O17SGk%2Fmc%2FpludvXZwFRFmRInvVUQoeU2bof3maMuOODTo3HRfrWABH4P8IkNYeipuFZDkYBJfQSgg4hqtEqV8BF0AFKxPOieannxJaBs%2BCTdW1mweo%2F9JYryeYJiQLfcW7SlVdkp0qeR%2FbDxVwLM4q5kB17HNyKgpHshL8YS2B%2F3nSZnFYYan2y94r0Hknsjv3zyoj8JbVaJHtADOZq%2F59HUQKTz9Ikp7E0SftFvM00NAD3UCOfo6FYKwYtvREUXqfJxf4DMKx0yVY2DYGZ%2FZ2hR2VTQdLuLYajcg%2BY9IYZsvEyU5YS%2FTHnMmMK3ZqOPVW47tPZfNwu4SlM%2BDc5eMbBMBU8LTVcS2CINffdc2R0dCy8zFf0Mrno1jUbLb4oCCAlv8gFgOnvBspcnCGRUaoI3%2F6TYEDadEgV9oI%2FcpLo41cF0qSVQhmgGWmBaX8GnIW25I1pBOvaybJWh7rm9YegjsmZLwbm21FGhsX2lOX2YObe5wqw2Vo%2FJbmCAZ7wrSLIa8UXmAVM9tx83AZH2b3tXOp7lPJHy5yOBx2COqRGbjy%2B5GC8rx%2BVR%2FTb6YXQ0VH5KYIXEf2vUSVSCDbRA1g64iUFcO3tu%2BADHQSVpIfB2pjDmlMGjBjqaAb%2BKJSsm5ccrrGQgHMJbmPiqn0g4GEvFxDm9IVN8YDjmtnqb5T8uGcXuDvdLjlJ9YAJaMBazEaehj2oXlZfPdHzYgH2ypTEgtXsWEZBF%2BwpUqEAzIgkHWKnpePwMC73Jo%2BujsmTckMsKtsURuj4%2B7yfsXbg74%2By%2Fdm09%2BalelD6TSr43yGCh3MJK5EfRljugsOYy05%2BfqMlD2q8%3D&X-Amz-SignedHeaders=host&partNumber=3&uploadId=OszKAZjpmN.42t7e_Sm2BD1LzTu_gODwzPS2pm1fgVnR54LgiptLMgpdmQTBkH2XyoAtHHR4bIiFiRay2sm3eL678r2uJ0DvFl.4ZpXw8F4VF_BfnDP4QDPvq4oe.huduDRIYcpisZGqCN3BiH5wSgiKoSZ7bpfmx3VoNLgS6w4-&x-id=UploadPart&X-Amz-Signature=0322a1143529ce9eba82f1d5087ad785d253dea913a1a1db8bf8bc1207099c8b"
      }
    ]
  }
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...