Definition File
definitions_File.html#/definitions/File/properties/content definitions_File.htmldefinitions_File.html#/definitions/File/properties/content_path definitions_File.html#/definitions/File/properties/id definitions_File.html#/definitions/File/properties/name definitions_File.html#/definitions/File/properties/section definitions_File.html#/definitions/File/properties/size
Diagram
Type object
Properties
Name Occurrence
content
content_path
id
name
section
size
optional
optional
optional
optional
optional
optional
Additional Properties true
Used by
Source

 "File": {
  "type": "object",
  "example": {
    "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo=",
    "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
    "id": "6r65pjq33banznomn7q22sj44e",
    "name": "foo.txt",
    "size": 35
  },
  "properties": {
    "content": {
      "type": "string",
      "description": "Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`."
    },
    "content_path": {
      "type": "string",
      "description": "Path of the Connect API that can be used to download the contents of this file.",
      "readOnly": true
    },
    "id": {
      "type": "string",
      "description": "ID of the file"
    },
    "name": {
      "type": "string",
      "description": "Name of the file"
    },
    "section": {
      "type": "object",
      "description": "For files that are in a section, this field describes the section.",
      "properties": {}
    },
    "size": {
      "type": "integer",
      "description": "Size in bytes of the file"
    }
  }
}


Definition content
Annotations
Description  Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`.
Diagram
Type string
Used by
Schema
File
Source

 "content": {
  "type": "string",
  "description": "Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`."
}


Definition content_path
Annotations
Description  Path of the Connect API that can be used to download the contents of this file.
Diagram
Type string
Used by
Schema
File
Source

 "content_path": {
  "type": "string",
  "description": "Path of the Connect API that can be used to download the contents of this file.",
  "readOnly": true
}


Definition id
Annotations
Description  ID of the file
Diagram
Type string
Used by
Schema
File
Source

 "id": {
  "type": "string",
  "description": "ID of the file"
}


Definition name
Annotations
Description  Name of the file
Diagram
Type string
Used by
Schema
File
Source

 "name": {
  "type": "string",
  "description": "Name of the file"
}


Definition section
definitions_File.html#/definitions/File/properties/section/properties/id
Annotations
Description  For files that are in a section, this field describes the section.
Diagram
Type object
Properties
Name Occurrence
id
optional
Additional Properties true
Used by
Schema
File
Source

 "section": {
  "type": "object",
  "description": "For files that are in a section, this field describes the section.",
  "properties": {
    "id": {"type": "string"}
  }
}


Definition id
Diagram
Type string
Used by
Source

 "id": {"type": "string"}


Definition size
Annotations
Description  Size in bytes of the file
Diagram
Type number
Used by
Schema
File
Source

 "size": {
  "type": "integer",
  "description": "Size in bytes of the file"
}