api-flow
Version:
A flow written in ES6 using Immutable to convert between API description formats (Swagger, etc.) and other programs such as cURL command lines.
1,411 lines (1,410 loc) • 321 kB
YAML
#%RAML 0.8
---
title: Box.com API
version: "2.0"
baseUri: https://api.box.com/{version}/
securitySchemes:
- oauth_2_0:
description: |
The Box API uses OAuth 2 for authentication. An authorization header containing
a valid access_token must be included in every request.
type: OAuth 2.0
describedBy:
headers:
Authorization:
description: |
Used to send a valid OAuth 2 access token. Do not use together with
the "access_token" query string parameter.
type: string
queryParameters:
access_token:
description: |
Used to send a valid OAuth 2 access token. Do not use together with
the "Authorization" header
type: string
settings:
authorizationUri: https://www.box.com/api/oauth2/authorize
accessTokenUri: https://www.box.com/api/oauth2/token
authorizationGrants: [ code, token ]
securedBy: [ oauth_2_0 ]
mediaType: application/json
resourceTypes:
- base:
get:
securedBy: [ oauth_2_0: { scopes: [ ADMINISTRATOR ] }]
headers:
If-None-Match?:
description: |
If-None-Match headers ensure that you don’t retrieve unnecessary data
if you already have the most current version on-hand.
type: string
On-Behalf-Of?:
description: |
Used for enterprise administrators to make API calls on behalf of their
managed users. To enable this functionality, please contact us with your
API key.
type: string
responses:
200?:
description: |
The request has succeeded. The information returned with the response
is dependent on the method used in the request.
202?:
description: |
The request has been accepted for processing, but the processing has
not been completed.
302?:
description: "Found. The requested resource resides temporarily under a different URI."
304?:
description: |
Not Modified. If the client has performed a conditional GET request
and access is allowed, but the document has not been modified
400:
description: |
Bad Request. The request could not be understood by the server due
to malformed syntax.
401:
description: "Unauthorized. The request requires user authentication."
404:
description: "Not Found. The server has not found anything matching the Request-URI."
429:
description: "Your application is sending too many simultaneous requests."
500:
description: "We couldn't return the representation due to an internal server error."
507:
description: |
Insufficient Storage. The server is unable to store the representation
needed to complete the request
post?:
headers:
If-Match?:
description: |
If-Match header let you ensure that your app only alters files/folders
on Box if you have the current version.
type: string
Content-MD5:
description: The SHA1 hash of the file.
type: string
responses:
201?:
description: |
The request has been fulfilled and resulted in a new resource being
created.
403:
description: |
Forbidden. The server understood the request, but is refusing to
fulfill it.
405:
description: |
Method Not Allowed. The method specified in the Request-Line is not
allowed for the resource identified by the Request-URI.
409:
description: |
Conflict. The request could not be completed due to a conflict with
the current state of the resource. Often happened because of file
names duplication.
429:
description: "Your application is sending too many simultaneous requests."
put?:
headers:
If-Match?:
description: |
If-Match header let you ensure that your app only alters files/folders
on Box if you have the current version.
type: string
responses:
200?:
description: |
The request has succeeded. The information returned with the response
is dependent on the method used in the request.
429:
description: "Your application is sending too many simultaneous requests."
delete?:
headers:
If-Match?:
description: |
If-Match header let you ensure that your app only alters files/folders
on Box if you have the current version.
type: string
responses:
204?:
description: |
"No Content. The server has fulfilled the request but does not need to
return an entity-body, and might want to return updated metainformation."
404:
description: "The file is not in the trash."
412:
description: |
Precondition Failed. The precondition given in one or more of the
request-header fields evaluated to false when it was tested on the
server.
429:
description: "Your application is sending too many simultaneous requests."
traits:
- secured:
queryParameters:
<<tokenName>>:
description: A valid <<tokenName>> is required
paged:
queryParameters:
numPages:
description: The number of pages to return, not to exceed <<maxPages>>
/folders:
type: base
post:
is: [ secured: { tokenName: access_token }, paged: { maxPages: 10 } ]
description: |
Used to create a new empty folder. The new folder will be created
inside of the specified parent folder
body:
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object" ,
"properties": {
"name": {
"description": "The desired name for the folder.",
"type": "string"
},
"parent": {
"description": "The parent folder.",
"type": "object"
},
"id": {
"description": "The ID of the parent folder.",
"type": "string"
}
},
"required": [ "name", "parent", "id" ]
}
responses:
200:
body:
example: |
{
"type": "folder",
"id": "11446498",
"sequence_id": "1",
"etag": "1",
"name": "Pictures",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T11:15:04-08:00",
"description": "Some pictures I took",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
}
]
},
"created_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"modified_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"owned_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/vspke7y05sb214wjokpk",
"vanity_url": null,
"is_password_enabled": false,
"unshared_at": null,
"download_count": 0,
"preview_count": 0,
"access": "open",
"permissions": {
"can_download": true,
"can_preview": true
}
},
"folder_upload_email": {
"access": "open",
"email": "upload.Picture.k13sdz1@u.box.com"
},
"parent": {
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
},
"item_status": "active",
"item_collection": {
"total_count": 0,
"entries": [],
"offset": 0,
"limit": 100
}
}
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object" ,
"properties": {
"type": {
"description": "For folders is 'folder'.",
"type": "string"
},
"id": {
"description": "The folder’s ID.",
"type": "string"
},
"sequence_id": {
"description": "A unique ID for use with the /events endpoint.",
"type": "string"
},
"etag": {
"description": "A unique string identifying the version of this folder.",
"type": "string"
},
"name": {
"description": "The name of the folder.",
"type": "string"
},
"created_at": {
"description": "The time the folder was created.",
"type": "timestamp"
},
"modified_at": {
"description": "The time the folder or its contents were last modified.",
"type": "timestamp"
},
"description": {
"description": "The description of the folder.",
"type": "string"
},
"size": {
"description": "The folder size in bytes.",
"type": "integer"
},
"path_collection": {
"paths": {
"properties": {
"total_count": {
"type": "integer"
},
"entries": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"sequence_id": {
"type": "string"
},
"etag": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"description": "Array of entries.",
"type": "array"
},
"type": "object"
},
"description": "Array of paths.",
"type": "array"
},
"created_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who created this folder.",
"type": "object"
},
"modified_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who last modified this folder.",
"type": "object"
},
"owned_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who owns this folder.",
"type": "object"
},
"shared_link": {
"properties": {
"url": {
"type": "string"
},
"download_url": {
"type": "string"
},
"vanity_url": {
"type": "string"
},
"is_password_enabled": {
"type": "boolean"
},
"unshared_at": {
"type": "string"
},
"download_count": {
"type": "integer"
},
"preview_count": {
"type": "integer"
},
"access": {
"type": "string"
},
"permissions": {
"properties": {
"can_download": {
"type": "boolean"
},
"can_preview": {
"type": "boolean"
}
}
}
},
"description": "The shared link for this folder.",
"type": "object"
},
"folder_upload_email": {
"properties": {
"access": {
"type": "string"
},
"email": {
"type": "string"
}
},
"description": "The upload email address for this folder.",
"type": "object"
},
"parent": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"sequence_id": {
"type": "string"
},
"etag": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The folder that contains this one.",
"type": "object"
},
"item_status": {
"description": "Whether this item is deleted or not.",
"type": "string"
},
"item_collection": {
"items": {
"properties": {
"total_count": {
"type": "integer"
},
"entries": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"sequence_id": {
"type": "string"
},
"etag": {
"type": "string"
},
"sha1": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"description": "Array of entries",
"type": "array"
},
"type": "object"
},
"description": "A collection of mini file and folder objects contained in this folder.",
"type": "array"
},
"sync_state": {
"description": "Whether this folder will be synced by the Box sync clients or not.",
"required": false,
"enum": [ "synced", "not_synced", "partially_synced" ]
},
"has_collaborations": {
"description": "Whether this folder has any collaborators.",
"required": false,
"type": "boolean"
}
},
"type": "object"
}
/{folderId}:
type: base
uriParameters:
folderId:
description: |
The ID of the parent folder
type: string
get:
description: |
Retrieves the full metadata about a folder, including information about
when it was last updated as well as the files and folders contained in it.
The root folder of a Box account is always represented by the id "0".
responses:
200:
body:
example: |
{
"type": "folder",
"id": "11446498",
"sequence_id": "1",
"etag": "1",
"name": "Pictures",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T11:15:04-08:00",
"description": "Some pictures I took",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
}
]
},
"created_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"modified_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"owned_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/vspke7y05sb214wjokpk",
"vanity_url": null,
"is_password_enabled": false,
"unshared_at": null,
"download_count": 0,
"preview_count": 0,
"access": "open",
"permissions": {
"can_download": true,
"can_preview": true
}
},
"folder_upload_email": {
"access": "open",
"email": "upload.Picture.k13sdz1@u.box.com"
},
"parent": {
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
},
"item_status": "active",
"item_collection": {
"total_count": 1,
"entries": [
{
"type": "file",
"id": "5000948880",
"sequence_id": "3",
"etag": "3",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"name": "tigers.jpeg"
}
],
"offset": 0,
"limit": 100
}
}
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object" ,
"properties": {
"type": {
"description": "For files is 'file'",
"type": "string"
},
"id": {
"description": "Box’s unique string identifying this file.",
"type": "string"
},
"sequence_id": {
"description": "A unique ID for use with the /events endpoint.",
"type": "string"
},
"etag": {
"description": "A unique string identifying the version of this file.",
"type": "string"
},
"sha1": {
"description": "The sha1 hash of this file.",
"type": "string"
},
"name": {
"description": "The name of this file.",
"type": "string"
},
"description": {
"description": "The description of this file.",
"type": "string"
},
"size": {
"description": "Size of this file in bytes.",
"type": "integer"
},
"path_collection": {
"paths": {
"properties": {
"total_count": {
"type": "integer"
},
"entries": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"sequence_id": {
"type": "string"
},
"etag": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"description": "Array of entries.",
"type": "array"
},
"type": "object"
},
"description": "The path of folders to this item, starting at the root.",
"type": "array"
},
"created_at": {
"description": "When this file was created on Box’s servers.",
"type": "timestamp"
},
"modified_at": {
"description": "When this file was last updated on the Box servers.",
"type": "timestamp"
},
"trashed_at": {
"description": "When this file was last moved to the trash.",
"type": "timestamp"
},
"purged_at": {
"description": "When this file will be permanently deleted.",
"type": "timestamp"
},
"content_created_at": {
"description": "When the content of this file was created.",
"type": "timestamp"
},
"content_modified_at": {
"description": "When the content of this file was last modified.",
"type": "timestamp"
},
"created_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who first created file.",
"type": "object"
},
"modified_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who last updated this file.",
"type": "object"
},
"owned_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who owns this file.",
"type": "object"
},
"shared_link": {
"properties": {
"url": {
"type": "string"
},
"download_url": {
"type": "string"
},
"vanity_url": {
"type": "string"
},
"is_password_enabled": {
"type": "boolean"
},
"unshared_at": {
"type": "string"
},
"download_count": {
"type": "integer"
},
"preview_count": {
"type": "integer"
},
"access": {
"type": "string"
},
"permissions": {
"properties": {
"can_download": {
"type": "boolean"
},
"can_preview": {
"type": "boolean"
}
}
}
},
"description": "The shared link object for this file.",
"type": "object"
},
"parent": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"sequence_id": {
"type": "string"
},
"etag": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The folder this file is contained in.",
"type": "object"
},
"item_status": {
"description": "Whether this item is deleted or not.",
"type": "string"
},
"version_number": {
"description": "Whether this folder will be synced by the Box sync clients or not.",
"required": false,
"type": "string"
},
"comment_count": {
"description": "The number of comments on a file",
"required": false,
"type": "integer"
}
},
"type": "object"
}
put:
description: |
Used to update information about the folder. To move a folder, update the ID
of its parent. To enable an email address that can be used to upload files
to this folder, update the folder_upload_email attribute. An optional
If-Match header can be included to ensure that client only updates the folder
if it knows about the latest version.
body:
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object" ,
"properties": {
"name": {
"description": "The desired name for the folder.",
"type": "string"
},
"parent": {
"description": "The parent folder.",
"type": "object"
},
"id": {
"description": "The ID of the parent folder.",
"type": "string"
},
"description": {
"description": "The description of the folder.",
"type": "string"
},
"shared_link": {
"description": "An object representing this item’s shared link and associated permissions.",
"type": "object"
},
"access": {
"description": "The level of access required for this shared link.",
"type": [ "open", "company", "collaborators"]
},
"unshared_at": {
"description": "The day that this link should be disabled at. Timestamps are rounded off to the given day.",
"type": "timestamp"
}
},
"required": [ "name", "parent", "id"]
}
responses:
200:
body:
example: |
{
"type": "folder",
"id": "11446498",
"sequence_id": "1",
"etag": "1",
"name": "New Folder Name!",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T11:15:04-08:00",
"description": "Some pictures I took",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
}
]
},
"created_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"modified_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"owned_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/vspke7y05sb214wjokpk",
"vanity_url": null,
"is_password_enabled": false,
"unshared_at": null,
"download_count": 0,
"preview_count": 0,
"access": "open",
"permissions": {
"can_download": true,
"can_preview": true
}
},
"folder_upload_email": {
"access": "open",
"email": "upload.Picture.k13sdz1@u.box.com"
},
"parent": {
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
},
"item_status": "active",
"item_collection": {
"total_count": 1,
"entries": [
{
"type": "file",
"id": "5000948880",
"sequence_id": "3",
"etag": "3",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"name": "tigers.jpeg"
}
],
"offset": 0,
"limit": 100
}
}
delete:
description: |
Used to delete a folder. A recursive parameter must be included in order to
delete folders that have items inside of them. An optional If-Match header
can be included to ensure that client only deletes the folder if it knows
about the latest version.
queryParameters:
recursive:
description: Whether to delete this folder if it has items inside of it.
type: boolean
responses:
204:
description: Folder removed.
post:
description: |
Restores an item that has been moved to the trash. Default behavior is to
restore the item to the folder it was in before it was moved to the trash.
If that parent folder no longer exists or if there is now an item with the
same name in that parent folder, the new parent folder and/or new name
will need to be included in the request.
body:
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object" ,
"properties": {
"name": {
"description": "The new name for this item.",
"type": "string"
},
"parent": {
"description": "The new parent folder for this item.",
"type": "object"
},
"id": {
"description": "The id of the new parent folder.",
"type": "string"
}
}
}
responses:
201:
description: Item was succesfully created.
body:
example: |
{
"type": "folder",
"id": "588970022",
"sequence_id": "2",
"etag": "2",
"name": "heloo world",
"created_at": "2013-01-15T16:15:27-08:00",
"modified_at": "2013-02-07T13:26:00-08:00",
"description": "",
"size": 0,
"path_collection": {
"total_count": 1,
"entries": [
{
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
}
]
},
"created_by": {
"type": "user",
"id": "181757341",
"name": "sean test",
"login": "sean+test@box.com"
},
"modified_by": {
"type": "user",
"id": "181757341",
"name": "sean test",
"login": "sean+test@box.com"
},
"trashed_at": null,
"purged_at": null,
"content_created_at": "2013-01-15T16:15:27-08:00",
"content_modified_at": "2013-02-07T13:26:00-08:00",
"owned_by": {
"type": "user",
"id": "181757341",
"name": "sean test",
"login": "sean+test@box.com"
},
"shared_link": null,
"folder_upload_email": null,
"parent": {
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
},
"item_status": "active"
}
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object" ,
"properties": {
"type": {
"description": "For files is 'file'",
"type": "string"
},
"id": {
"description": "Box’s unique string identifying this file.",
"type": "string"
},
"sequence_id": {
"description": "A unique ID for use with the /events endpoint.",
"type": "string"
},
"etag": {
"description": "A unique string identifying the version of this file.",
"type": "string"
},
"sha1": {
"description": "The sha1 hash of this file.",
"type": "string"
},
"name": {
"description": "The name of this file.",
"type": "string"
},
"description": {
"description": "The description of this file.",
"type": "string"
},
"size": {
"description": "Size of this file in bytes.",
"type": "integer"
},
"path_collection": {
"paths": {
"properties": {
"total_count": {
"type": "integer"
},
"entries": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"sequence_id": {
"type": "string"
},
"etag": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"description": "Array of entries.",
"type": "array"
},
"type": "object"
},
"description": "The path of folders to this item, starting at the root.",
"type": "array"
},
"created_at": {
"description": "When this file was created on Box’s servers.",
"type": "timestamp"
},
"modified_at": {
"description": "When this file was last updated on the Box servers.",
"type": "timestamp"
},
"trashed_at": {
"description": "When this file was last moved to the trash.",
"type": "timestamp"
},
"purged_at": {
"description": "When this file will be permanently deleted.",
"type": "timestamp"
},
"content_created_at": {
"description": "When the content of this file was created.",
"type": "timestamp"
},
"content_modified_at": {
"description": "When the content of this file was last modified.",
"type": "timestamp"
},
"created_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who first created file.",
"type": "object"
},
"modified_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who last updated this file.",
"type": "object"
},
"owned_by": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"login": {
"type": "string"
}
},
"description": "The user who owns this file.",
"type": "object"
},
"shared_link": {
"properties": {
"url": {
"type": "string"
},
"download_url": {
"type": "string"
},
"vanity_url": {
"type": "string"
},
"is_password_enabled": {
"type": "boolean"
},
"unshared_at": {
"type": "string"
},
"download_count": {
"type": "integer"
},
"preview_count": {
"type": "integer"
},
"access": {
"type": "string"
},
"permissions": {
"properties": {
"can_download": {
"type": "boolean"
},
"can_preview": {
"type": "boolean"
}
}
}
},
"description": "The shared link object for this file.",
"type": "object"
},
"parent": {
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "string"
},
"sequence_id": {
"type": "string"
},
"etag": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The folder this file is contained in.",
"type": "object"
},
"item_status": {
"description": "Whether this item is deleted or not.",
"type": "string"
},
"version_number": {
"description": "Whether this folder will be synced by the Box sync clients or not.",
"required": false,
"type": "string"
},
"comment_count": {
"description": "The number of comments on a file",
"required": false,
"type": "integer"
}
},
"type": "object"
}
/copy:
type: base
post:
description: |
Used to create a copy of a folder in another folder. The original version
of the folder will not be altered.
body:
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object" ,
"properties": {
"name": {
"description": "An optional new name for the folder.",
"type": "string"
},
"parent": {
"description": "Object representing the new location of the folder.",
"type": "string"
},
"id": {
"description": "The ID of the destination folder.",
"type": "string"
}
},
"required": [ "parent", "id" ]
}
responses:
200:
body:
example: |
{
"type": "folder",
"id": "11446498",
"sequence_id": "1",
"etag": "1",
"name": "Pictures",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T11:15:04-08:00",
"description": "Some pictures I took",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
}
]
},
"created_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"modified_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"owned_by": {
"type": "user",
"id": "17738362",
"name": "sean rose",
"login": "sean@box.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/vspke7y05sb214wjokpk",
"vanity_url": null,
"is_password_enabled": false,
"unshared_at": null,
"download_count": 0,
"preview_count": 0,
"access": "open",
"permissions": {
"can_download": true,
"can_preview": true
}
},
"folder_upload_email": {
"access": "open",
"email": "upload.Picture.k13sdz1@u.box.com"
},
"parent": {
"type": "folder",
"id": "0",
"sequence_id": null,
"etag": null,
"name": "All Files"
},
"item_status": "active",
"item_collection": {
"total_count": 1,
"entries": [
{
"type": "file",
"id": "5000948880",
"sequence_id": "3",
"etag": "3",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"name": "tigers.jpeg"
}
],
"offset": 0,
"limit": 100
}
}
schema: |
{
"$schema": "http://json-schema.org/draft-03/schema",