Diagram
properties_File.html#/properties/File/properties/id properties_File.html#/properties/File/properties/name properties_File.html#/properties/File/properties/size properties_File.htmlproperties_File.html#/properties/File/properties/content_path properties_File.html#/properties/File/properties/section properties_File.html#/properties/File/properties/content diagram
Type object
Properties
Name Occurrence
id
name
size
content_path
section
content
 optional
optional
optional
optional
optional
optional
Used by
Schema
File
Source 

 "File": {
  "type": "object",
  "example": {
    "id": "6r65pjq33banznomn7q22sj44e",
    "name": "foo.txt",
    "size": 35,
    "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
    "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo="
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the file"
    },
    "name": {
      "type": "string",
      "description": "Name of the file"
    },
    "size": {
      "type": "integer",
      "description": "Size in bytes of the file"
    },
    "content_path": {
      "type": "string",
      "description": "Path of the Connect API that can be used to download the contents of this file.",
      "readOnly": true
    },
    "section": {
      "type": "object",
      "description": "For files that are in a section, this field describes the section.",
      "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`."
    }
  }
}
Annotations 
Description  ID of the file
Diagram
diagram
Type string
Used by
Schema
File
File/properties/id
Source 

 "id": {
  "type": "string",
  "description": "ID of the file"
}
Annotations 
Description  Name of the file
Diagram
diagram
Type string
Used by
Schema
File
File/properties/name
Source 

 "name": {
  "type": "string",
  "description": "Name of the file"
}
Annotations 
Description  Size in bytes of the file
Diagram
diagram
Type number
Used by
Schema
File
File/properties/size
Source 

 "size": {
  "type": "integer",
  "description": "Size in bytes of the file"
}
Annotations 
Description  Path of the Connect API that can be used to download the contents of this file.
Diagram
diagram
Type string
Used by
Schema
File
File/properties/content_path
Source 

 "content_path": {
  "type": "string",
  "description": "Path of the Connect API that can be used to download the contents of this file.",
  "readOnly": true
}
Annotations 
Description  For files that are in a section, this field describes the section.
Diagram
properties_File.html#/properties/File/properties/section/properties/id diagram
Type object
Properties
Name Occurrence
id
 optional
Used by
Schema
File
File/properties/section
Source 

 "section": {
  "type": "object",
  "description": "For files that are in a section, this field describes the section.",
  "properties": {
    "id": {"type": "string"}
  }
}
Diagram
diagram
Type string
Used by
Schema
File/properties/section
File/properties/section/properties/id
Source 

 "id": {"type": "string"}
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
diagram
Type string
Used by
Schema
File
File/properties/content
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`."
}