@datafire/box_content

DataFire integration for Box 2.0

Usage no npm install needed!

<script type="module">
  import datafireBoxContent from 'https://cdn.skypack.dev/@datafire/box_content';
</script>

README

@datafire/box_content

Client library for Box 2.0

Installation and Usage

npm install --save @datafire/box_content

let box_content = require('@datafire/box_content').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Box Content API gives you access to secure content management and content experience features for use in your own app. It strives to be RESTful and is organized around the main resources you’re familiar with from the Box web interface.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

box_content.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

box_content.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

getPendingCollaborations

Used to retrieve all pending collaboration invites for this user.

box_content.getPendingCollaborations({
  "status": ""
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • status required string (values: pending): Must be 'pending'

Output

createCollaboration

Used to add a collaboration for a single user or a single group to a folder. Either an email address, a user ID, or a group id can be used to create the collaboration. If the collaboration is being created with a group, access to this endpoint is granted based on the group's invitability_level.

box_content.createCollaboration({
  "body": {}
}, context)

Input

Output

deleteCollaboration

Used to delete a single collaboration.

box_content.deleteCollaboration({
  "COLLAB_ID": ""
}, context)

Input

  • input object
    • COLLAB_ID required string

Output

Output schema unknown

getCollaboration

Used to get information about a single collaboration. All collaborations for a single folder can be retrieved through GET /folders/{id}/collaborations. A complete list of the user’s pending collaborations can also be retrieved.

box_content.getCollaboration({
  "COLLAB_ID": ""
}, context)

Input

  • input object
    • COLLAB_ID required string
    • fields string: Attribute(s) to include in the response
    • status string (values: pending): Can only be pending

Output

updateCollaboation

Used to edit an existing collaboration. Descriptions of the various roles can be found here.

box_content.updateCollaboation({
  "COLLAB_ID": "",
  "body": {}
}, context)

Input

  • input object

Output

getCollections

Retrieves the collections for the given user. Currently, only the favorites collection is supported.

box_content.getCollections(null, context)

Input

This action has no parameters

Output

getCollectionItems

Retrieves the files and/or folders contained within this collection. Collection item lists behave a lot like getting a folder’s items. Paginated results can be retrieved using the limit and offset parameters. Sub-object fields can be requested via the ?fields parameter

box_content.getCollectionItems({
  "COLLECTION_ID": ""
}, context)

Input

  • input object
    • COLLECTION_ID required string
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return in a page.
    • offset string: The offset at which to begin the response. An offset of value of 0 will start at the beginning of the folder-listing. Offset of 2 would start at the 2nd record, not the second page. Note: If there are hidden items in your previous response, your next offset should be = offset + limit, not the # of records you received back.

Output

createComment

Used to add a comment by the user to a specific file or comment (i.e. as a reply comment).

box_content.createComment({
  "body": {}
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response.
    • body required Comment

Output

deleteComment

Permanently deletes a comment.

box_content.deleteComment({
  "COMMENT_ID": ""
}, context)

Input

  • input object
    • COMMENT_ID required string

Output

Output schema unknown

getComment

Used to retrieve the message and metadata about a specific comment. Information about the user who created the comment is also included.

box_content.getComment({
  "COMMENT_ID": ""
}, context)

Input

  • input object
    • COMMENT_ID required string
    • fields string: Attribute(s) to include in the response.

Output

updateComment

Used to update the message of the comment.

box_content.updateComment({
  "COMMENT_ID": "",
  "body": {}
}, context)

Input

  • input object
    • COMMENT_ID required string
    • fields string: Attribute(s) to include in the response.
    • body required Comment

Output

deleteDevicePin

Delete individual device pin.

box_content.deleteDevicePin({
  "ID": ""
}, context)

Input

  • input object
    • ID required string

Output

Output schema unknown

getDevicePin

Gets information about an individual device pin.

box_content.getDevicePin({
  "ID": ""
}, context)

Input

  • input object
    • ID required string

Output

getEnterpriseDevicePins

Gets all the device pins within a given enterprise. Must be an enterprise admin with the manage enterprise scope to make this call.

box_content.getEnterpriseDevicePins({
  "ENTERPRISE_ID": ""
}, context)

Input

  • input object
    • ENTERPRISE_ID required string
    • marker string: Needs not be passed or can be empty for first invocation of the API. Use the one returned in response for each subsequent call.
    • limit string: Default value is 100. Max value is 10000
    • direction string: Default is "asc". Valid values are asc, desc. Case in-sensitive, ASC/DESC works just fine.

Output

getUserEvents

Use this to get events for a given user. A chunk of event objects is returned for the user based on the parameters passed in. Parameters indicating how many chunks are left as well as the next stream_position are also returned.

To retrieve Enterprise Events specify 'stream_type=admin_logs'. Retrieves up to a year' events for all users in an enterprise. Upper and lower bounds as well as filters can be applied to the results.

box_content.getUserEvents({}, context)

Input

  • input object
    • stream_position string: The location in the event stream at which you want to start receiving events. Can specify special case ‘now’ to get 0 events and the latest stream position for initialization.
    • stream_type string (values: all, changes, sync, admin_logs): Limits the type of events returned: all: returns everything, changes: returns tree changes, sync: returns tree changes only for sync folders
    • limit integer: Limits the number of events returned
    • event_type string: A comma-separated list of events to filter by
    • created_after string: A lower bound on the timestamp of the events returned
    • created_before string: An upper bound on the timestamp of the events returned

Output

eventLongPolling

To get real-time notification of activity in a Box account, use the long poll feature of the /events API. To do so, first call the /events API with an OPTIONS call to retrieve the long poll URL to use. Next, make a GET request to the provided URL to begin listening for events. If an event occurs within an account you are monitoring, you will receive a response with the value new_change. It’s important to note that this response will not come with any other details, but should serve as a prompt to take further action such as calling the /events endpoint with your last known stream_position. After sending this response, the server will close the connection and you will need to repeat the long poll process to begin listening for events again. If no events occur for a period of time after you make the GET request to the long poll URL, you will receive a response with the value reconnect. When you receive this response, you’ll make another OPTIONS call to the /events endpoint and repeat the long poll process. If you receive no events in retry_timeout seconds, you should make another GET request to the real time server (i.e. URL in the response). This might be necessary in case you do not receive the reconnect message in the face of network errors. If you receive max_retries error when making GET requests to the real time server, you should make another OPTIONS request.

box_content.eventLongPolling(null, context)

Input

This action has no parameters

Output

getFileVersionLegalHoldPolicies

Get list of non-deleted Holds for a single Policy.

box_content.getFileVersionLegalHoldPolicies({
  "policy_id": ""
}, context)

Input

  • input object
    • policy_id required string

Output

getFileVersionLegalHoldPolicy

Get details of a single File Version Legal Hold.

box_content.getFileVersionLegalHoldPolicy({
  "ID": ""
}, context)

Input

  • input object
    • ID required string

Output

getFileVersionRetentions

Retrieves all file version retentions for the given enterprise.

box_content.getFileVersionRetentions({}, context)

Input

  • input object
    • file_id string: A file id to filter the file version retentions by.
    • file_version_id string: A file version id to filter the file version retentions by.
    • policy_id string: A policy id to filter the file version retentions by.
    • disposition_action string (values: permanently_delete, remove_retention): The disposition action of the retention policy. This action can be permanently_delete, which will cause the content retained by the policy to be permanently deleted, or remove_retention, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy time period has passed.
    • disposition_before string: See content times for formatting
    • disposition_after string: See content times for formatting
    • limit integer: The maximum number of items to return in a page
    • marker string: Base 64 encoded string that represents where the paging should being. It should be left blank to begin paging.

Output

getFileVersionRetention

Used to retrieve information about a file version retention

box_content.getFileVersionRetention({
  "FILE_VERSION_RETENTION_ID": ""
}, context)

Input

  • input object
    • FILE_VERSION_RETENTION_ID required string

Output

fileUploadPreflightCheck

The Pre-flight check API will verify that a file will be accepted by Box before you send all the bytes over the wire.

box_content.fileUploadPreflightCheck({
  "body": {}
}, context)

Input

  • input object

Output

Output schema unknown

deleteFile

Discards a file to the trash. The etag of the file can be included as an ‘If-Match’ header to prevent race conditions.

box_content.deleteFile({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • If-Match string: The etag of the file. This is in the ‘etag’ field of the file object.

Output

Output schema unknown

getFile

Used to retrieve the metadata about a file.

box_content.getFile({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • fields string: Attribute(s) to include in the response.

Output

restoreTrashedFile

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.

box_content.restoreTrashedFile({
  "FILE_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FILE_ID required string
    • body required BoxFile

Output

updateFileInfo

Used to update individual or multiple fields in the file object, including renaming the file, changing its description, and creating a shared link for the file. To move a file, change the ID of its parent folder. An optional If-Match header can be included to prevent race conditions.

To lock and unlock files, you execute a PUT operation on the /files/{file id} endpoint and set or clear the lock properties on the file.

Used to create a shared link for this particular file. Please see here for more information on the permissions available for shared links. In order to get default shared link status, set it to an empty access level, i.e. {"shared_link": {}}. In order to disable a shared link, send this same type of PUT request with the value of shared_link set to null, i.e. {"shared_link": null}

box_content.updateFileInfo({
  "FILE_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FILE_ID required string
    • body required BoxFile
    • If-Match string: The etag of the file can be included as an ‘If-Match’ header to prevent race conditions.

Output

getFileCollaborations

Use this to get a list of all the collaborations on a file

box_content.getFileCollaborations({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return in a page
    • offset integer: The item at which to begin the response

Output

getFileComments

Retrieves the comments on a particular file, if any exist.

box_content.getFileComments({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • fields string: Attribute(s) to include in the response

Output

getFileContent

Retrieves the actual data of the file. An optional version parameter can be set to download a previous version of the file.

box_content.getFileContent({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • Range string: The range value in bytes. Format should be bytes={start_range}-{end_range}
    • version string: The ID specific version of this file to download.
    • BoxApi string: The shared link for this item. Format should be shared_link=SHARED_LINK

Output

Output schema unknown

copyFile

Used to create a copy of a file in another folder. The original version of the file will not be altered.

box_content.copyFile({
  "FILE_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FILE_ID required string
    • body required CopyFile

Output

getAllFileMetadata

Used to retrieve all metadata associated with a given file

box_content.getAllFileMetadata({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string

Output

deleteFileMetadata

Used to delete the template instance. To delete custom key:value pairs within a template instance, you should refer to the updating metadata section.

box_content.deleteFileMetadata({
  "FILE_ID": "",
  "SCOPE": "",
  "TEMPLATE": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • SCOPE required string
    • TEMPLATE required string

Output

Output schema unknown

getFileMetadata

Used to retrieve the metadata template instance for a corresponding Box file.

box_content.getFileMetadata({
  "FILE_ID": "",
  "SCOPE": "",
  "TEMPLATE": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • SCOPE required string
    • TEMPLATE required string

Output

createFileMetadata

Used to create the metadata template instance for a corresponding Box file. When creating metadata, only values that adhere to the metadata template schema will be accepted.

box_content.createFileMetadata({
  "FILE_ID": "",
  "SCOPE": "",
  "TEMPLATE": "",
  "body": {}
}, context)

Input

  • input object
    • FILE_ID required string
    • SCOPE required string
    • TEMPLATE required string
    • body required Metadata

Output

updateFileMetadata

Used to update the template instance. The request body must follow the JSON-Patch specification, which is represented as a JSON array of operation objects (see examples for more details). Updates can be either add, replace, remove , test, move, or copy. The template instance can only be updated if the template instance already exists. When editing metadata, only values that adhere to the metadata template schema will be accepted. The update is applied atomically. If any errors occur during the application of the update operations, the metadata instance remains unchanged.

box_content.updateFileMetadata({
  "FILE_ID": "",
  "SCOPE": "",
  "TEMPLATE": "",
  "body": []
}, context)

Input

  • input object
    • FILE_ID required string
    • SCOPE required string
    • TEMPLATE required string
    • body required UpdateMetadata

Output

getFileTasks

Retrieves all of the tasks for given file.

box_content.getFileTasks({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • fields string: Attribute(s) to include in the response

Output

getFileThumbnail

Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 94x94, 160x160, and 320x320 can be returned in the .jpg format. Thumbnails can be generated for the image and video file formats listed here.

box_content.getFileThumbnail({
  "FILE_ID": "",
  "EXTENSION": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • EXTENSION required string: The preview format, e.g. png or jpg
    • min_height integer: The minimum height of the thumbnail
    • min_width integer: The minimum width of the thumbnail
    • max_height integer: The maximum height of the thumbnail
    • max_width integer: The maximum width of the thumbnail

Output

deleteTrashedFile

Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone.

box_content.deleteTrashedFile({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string

Output

Output schema unknown

getTrashedFile

Retrieves an item that has been moved to the trash.

box_content.getTrashedFile({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string

Output

getFileVersions

If there are previous versions of this file, this method can be used to retrieve information about the older versions. (Versions are only tracked for Box users with premium accounts.)

box_content.getFileVersions({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • fields string: Attribute(s) to include in the response

Output

promotoeFileVersion

If there are previous versions of this file, this method can be used to promote one of the older versions to the top of the stack. This actually mints a copy of the old version and puts it on the top of the versions stack. The file will have the exact same contents, the same SHA1/etag, and the same name as the original. Other properties such as comments do not get updated to their former values.

box_content.promotoeFileVersion({
  "FILE_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FILE_ID required string
    • body required Reference

Output

deleteFileVersion

Discards a specific file version to the trash. (Depending on the enterprise settings for this user, the item will either be actually deleted from Box or moved to the trash.)

box_content.deleteFileVersion({
  "FILE_ID": "",
  "VERSION_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string
    • VERSION_ID required string
    • If-Match string: The etag of the file. This is in the ‘etag’ field of the file object.

Output

Output schema unknown

deleteFileWatermark

Used to remove the watermark for a corresponding Box file.

box_content.deleteFileWatermark({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string

Output

getFileWatermark

Used to retrieve the watermark for a corresponding Box file.

box_content.getFileWatermark({
  "FILE_ID": ""
}, context)

Input

  • input object
    • FILE_ID required string

Output

updateFileWatermark

Used to apply or update the watermark for a corresponding Box file. The endpoint accepts a JSON body describing the watermark to apply.

box_content.updateFileWatermark({
  "FILE_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FILE_ID required string
    • body required Watermark

Output

createFolder

Used to create a new empty folder. The new folder will be created inside of the specified parent folder

box_content.createFolder({
  "body": {}
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • body required Folder

Output

getTrashedItems

Retrieves the files and/or folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at. Paginated results can be retrieved using the limit and offset parameters.

box_content.getTrashedItems({}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return
    • offset integer: The item at which to begin the response

Output

deleteFolder

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.

box_content.deleteFolder({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string
    • recursive boolean
    • If-Match string: This is in the ‘etag’ field of the folder object.

Output

Output schema unknown

getFolder

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”.

box_content.getFolder({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • FOLDER_ID required string

Output

restoreTrashedFolder

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.

box_content.restoreTrashedFolder({
  "FOLDER_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FOLDER_ID required string
    • fields string: Attribute(s) to include in the response
    • body required Folder

Output

updateFolder

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.

Used to create a shared link for this particular folder. Please see here for more information on the permissions available for shared links. In order to get default shared link status, set it to an empty access level, i.e. {"shared_link": {}}. In order to disable a shared link, send this same type of PUT request with the value of shared_link set to null, i.e. {"shared_link": null}

To add or remove an item from a collection, you do a PUT on that item and change the list of collections it belongs to. Philosophically, this is similar to the way “move” operations work on files and folders: you do a PUT on the item and change its parent. It’s the same idea with collections, except you’re changing which collection(s) the item belongs to instead of the folder it belongs to. Currently the only collection available is the favorites collection, and you’ll need to know it’s ID for the user that is making the API call, since every user has a different favorites collection_id. The Add/Remove API handling will check all ids passed in before performing any add/removal operations. If any collection ids are malformed or do not exist in the user’s account, the API call will throw a 400. Only if all of the collection ids are valid will the adds and removals be carried out.

box_content.updateFolder({
  "FOLDER_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FOLDER_ID required string
    • fields string: Attribute(s) to include in the response
    • body required Folder
    • If-Match string: This is in the ‘etag’ field of the folder object.

Output

getFolderCollaborations

Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

box_content.getFolderCollaborations({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return in a page. The default is 100 and the max is 1000.
    • offset integer: The item at which to begin the response

Output

copyFolder

Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

box_content.copyFolder({
  "FOLDER_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FOLDER_ID required string
    • fields string: Attribute(s) to include in the response
    • body required Folder

Output

getFolderItems

Retrieves the files and/or folders contained within this folder without any other metadata about the folder. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at. Paginated results can be retrieved using the limit and offset parameters.

box_content.getFolderItems({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return in a page. The default is 100 and the max is 1000.
    • offset string: The offset at which to begin the response. An offset of value of 0 will start at the beginning of the folder-listing. Note: If there are hidden items in your previous response, your next offset should be = offset + limit, not the # of records you received back. The default is 0.

Output

getAllFolderMetadata

Used to retrieve all metadata associated with a given folder

box_content.getAllFolderMetadata({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string

Output

deleteFolderMetadata

Used to delete the template instance. To delete custom key:value pairs within a template instance, you should refer to the updating metadata section.

box_content.deleteFolderMetadata({
  "FOLDER_ID": "",
  "SCOPE": "",
  "TEMPLATE": ""
}, context)

Input

  • input object
    • FOLDER_ID required string
    • SCOPE required string
    • TEMPLATE required string

Output

Output schema unknown

getFolderMetadata

Used to retrieve the metadata template instance for a corresponding Box folder.

box_content.getFolderMetadata({
  "FOLDER_ID": "",
  "SCOPE": "",
  "TEMPLATE": ""
}, context)

Input

  • input object
    • FOLDER_ID required string
    • SCOPE required string
    • TEMPLATE required string

Output

createFolderMetadata

Used to create the metadata template instance for a corresponding Box folder. When creating metadata, only values that adhere to the metadata template schema will be accepted.

box_content.createFolderMetadata({
  "FOLDER_ID": "",
  "SCOPE": "",
  "TEMPLATE": "",
  "body": {}
}, context)

Input

  • input object
    • FOLDER_ID required string
    • SCOPE required string
    • TEMPLATE required string
    • body required Metadata

Output

updateFolderMetadata

Used to update the template instance. Updates can be either add, replace, remove , or test. The template instance can only be updated if the template instance already exists. When editing metadata, only values that adhere to the metadata template schema will be accepted.

box_content.updateFolderMetadata({
  "FOLDER_ID": "",
  "SCOPE": "",
  "TEMPLATE": "",
  "body": []
}, context)

Input

  • input object
    • FOLDER_ID required string
    • SCOPE required string
    • TEMPLATE required string
    • body required UpdateMetadata

Output

deleteTrashedFolder

Permanently deletes an folder that is in the trash. The item will no longer exist in Box. This action cannot be undone.

box_content.deleteTrashedFolder({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string

Output

Output schema unknown

getTrashedFolder

Retrieves an folder that has been moved to the trash.

box_content.getTrashedFolder({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string
    • fields string: Attribute(s) to include in the response

Output

deleteFolderWatermark

Used to remove the watermark for a corresponding Box Folder.

box_content.deleteFolderWatermark({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string

Output

getFolderWatermark

Used to retrieve the watermark for a corresponding Box folder.

box_content.getFolderWatermark({
  "FOLDER_ID": ""
}, context)

Input

  • input object
    • FOLDER_ID required string

Output

updateFolderWatermark

Used to apply or update the watermark for a corresponding Box folder. The endpoints accepts a JSON body describing the watermark to apply.

box_content.updateFolderWatermark({
  "FOLDER_ID": "",
  "body": {}
}, context)

Input

  • input object
    • FOLDER_ID required string
    • body required Watermark

Output

createGroupMembership

Used to add a member to a Group.

box_content.createGroupMembership({
  "body": {}
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • body required GroupMembership

Output

deleteGroupMembership

Deletes a specific group membership.

box_content.deleteGroupMembership({
  "GROUP_MEMBERSHIP_ID": ""
}, context)

Input

  • input object
    • GROUP_MEMBERSHIP_ID required string

Output

Output schema unknown

getGroupMembership

Fetches a specific group membership entry.

box_content.getGroupMembership({
  "GROUP_MEMBERSHIP_ID": ""
}, context)

Input

  • input object
    • GROUP_MEMBERSHIP_ID required string
    • fields string: Attribute(s) to include in the response

Output

updateGroupMembership

Used to update a group membership.

box_content.updateGroupMembership({
  "GROUP_MEMBERSHIP_ID": "",
  "body": {}
}, context)

Input

  • input object
    • GROUP_MEMBERSHIP_ID required string
    • fields string: Attribute(s) to include in the response
    • body required GroupMembership

Output

getEnterpriseGroups

Retrieves all of the groups for given enterprise. Must have permissions to see an enterprise's groups.

box_content.getEnterpriseGroups({}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return in a page. The default is 100 and the max is 1000.
    • offset integer: The item at which to begin the response.

Output

createGroup

Used to create a group.

box_content.createGroup({
  "body": {}
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • body required Group

Output

deleteGroup

Permanently deletes a specific group.

box_content.deleteGroup({
  "GROUP_ID": ""
}, context)

Input

  • input object
    • GROUP_ID required string

Output

Output schema unknown

getGroup

Used to get information about a group.

box_content.getGroup({
  "GROUP_ID": ""
}, context)

Input

  • input object
    • GROUP_ID required string
    • fields string: Attribute(s) to include in the response

Output

updateGroup

Updates a specific group.

box_content.updateGroup({
  "GROUP_ID": "",
  "body": {}
}, context)

Input

  • input object
    • GROUP_ID required string
    • fields string: Attribute(s) to include in the response
    • body required Group

Output

getGroupCollaborations

Retrieves all of the group collaborations for a given group. Note this is only available to group admins.

box_content.getGroupCollaborations({
  "GROUP_ID": ""
}, context)

Input

  • input object
    • GROUP_ID required string
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return in a page. The default is 100 and the max is 1000.
    • offset integer: The item at which to begin the response.

Output

getGroupMemberships

Retrieves all of the members for a given group if the requesting user has access (see Group Object member_viewability_level).

box_content.getGroupMemberships({
  "GROUP_ID": ""
}, context)

Input

  • input object
    • GROUP_ID required string
    • fields string: Attribute(s) to include in the response
    • limit integer: The maximum number of items to return in a page. The default is 100 and the max is 1000.
    • offset integer: The item at which to begin the response.

Output

createInvite

Invites an existing user to join an Enterprise. The existing user can not be part of another Enterprise and must already have a Box account. Once invited, the user will receive an email and prompt to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope for the enterprise, which can be enabled within your developer console.

box_content.createInvite({
  "body": {}
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • body required InviteUser

Output

getInvite

Get status of the invite

box_content.getInvite({
  "INVITE_ID": ""
}, context)

Input

  • input object
    • INVITE_ID required string
    • fields string: Attribute(s) to include in the response

Output

getLegalHoldPolicies

Get a list of Legal Hold Policies that belong to your Enterprise.

box_content.getLegalHoldPolicies({}, context)

Input

  • input object
    • policy_name string: Case insensitive prefix-match filter on Policy name.
    • limit integer: Limit result size to this number. Defaults to 100, maximum is 1,000.
    • marker string: Take from next_marker column of a prior call to get the next page

Output

createLegalHoldPolicy

Create a new Legal Hold Policy. Optional date filter may be passed. If Policy has a date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range.

box_content.createLegalHoldPolicy({
  "body": {}
}, context)

Input

Output

deleteLegalHoldPolicy

Sends request to delete an existing Legal Hold Policy. Note that this is an asynchronous process - the Policy will not be fully deleted yet when the response comes back.

box_content.deleteLegalHoldPolicy({
  "ID": ""
}, context)

Input

  • input object
    • ID required string

Output

Output schema unknown

getLegalHoldPolicy

Get details of a single Legal Hold Policy

box_content.getLegalHoldPolicy({
  "ID": ""
}, context)

Input

  • input object
    • ID required string

Output

updateLegalHoldPolicy

Update existing Legal Hold Policy. Only name and description can be modified.

box_content.updateLegalHoldPolicy({
  "ID": "",
  "body": {}
}, context)

Input

Output

getLegalHoldPolicyAssignments

Get list of assignments for a single Policy.

box_content.getLegalHoldPolicyAssignments({
  "ID": ""
}, context)

Input

  • input object
    • ID required string

Output

createLegalHoldPolicyAssignment

Create a new Assignment, which will apply the Legal Hold Policy to the target of the Assignment.

box_content.createLegalHoldPolicyAssignment({
  "body": {}
}, context)

Input

Output

deleteLegalHoldPolicyAssignment

Sends request to delete an existing Assignment. Note that this is an asynchronous process - the Assignment will not be fully deleted yet when the response comes back.

box_content.deleteLegalHoldPolicyAssignment({
  "ASSIGNMENT_ID": ""
}, context)

Input

  • input object
    • ASSIGNMENT_ID required string

Output

Output schema unknown

getLegalHoldPolicyAssignment

Get details of a single assignment.

box_content.getLegalHoldPolicyAssignment({
  "ASSIGNMENT_ID": ""
}, context)

Input

  • input object
    • ASSIGNMENT_ID required string

Output

Output schema unknown

createMetadataTemplate

Used to create a new metadata template with the specified schema.

box_content.createMetadataTemplate({
  "body": {}
}, context)

Input

Output

getEnterpriseMetadataTemplates

Used to retrieve all metadata templates within a user's enterprise. Currently only the enterprise scope is supported.

box_content.getEnterpriseMetadataTemplates({
  "SCOPE": ""
}, context)

Input

  • input object
    • SCOPE required string

Output

getMetadataTemplate

Used to retrieve the schema for a given metadata template.

box_content.getMetadataTemplate({
  "SCOPE": "",
  "TEMPLATE": ""
}, context)

Input

  • input object
    • SCOPE required string
    • TEMPLATE required string

Output

updateMetadataTemplate

Used to update the schema of an existing template.

box_content.updateMetadataTemplate({
  "SCOPE": "",
  "TEMPLATE": "",
  "body": []
}, context)

Input

Output

getRetentionPolicies

Retrieves all of the retention policies for the given enterprise.

box_content.getRetentionPolicies({}, context)

Input

  • input object
    • policy_name string: A name to filter the retention policies by. A trailing partial match search is performed.
    • policy_type string (values: finite, indefinite): A policy type to filter the retention policies by.
    • created_by_user_id string: A user id to filter the retention policies by.

Output

createRetentionPolicy

Used to create a new retention policy.

box_content.createRetentionPolicy({
  "body": {}
}, context)

Input

Output

getRetentionPolicy

Used to retrieve information about a retention policy

box_content.getRetentionPolicy({
  "POLICY_ID": ""
}, context)

Input

  • input object
    • POLICY_ID required string

Output

updateRetentionPolicy

Used to update a retention policy.

box_content.updateRetentionPolicy({
  "POLICY_ID": "",
  "body": {}
}, context)

Input

Output

getRetentionPolicyAssignments

Returns a list of all retention policy assignments associated with a specified retention policy.

box_content.getRetentionPolicyAssignments({
  "POLICY_ID": ""
}, context)

Input

  • input object
    • POLICY_ID required string
    • type string (values: folder, enterprise): The type of the retention policy assignment to retrieve. Can either be folder or enterprise.

Output

createRetentionPolicyAssignment

Returns a list of all retention policy assignments associated with a specified retention policy.

box_content.createRetentionPolicyAssignment({
  "body": {}
}, context)

Input

Output

getRetentionPolicyAssignment

Used to retrieve information about a retention policy assignment.

box_content.getRetentionPolicyAssignment({
  "RETENTION_POLICY_ASSIGNMENT_ID": ""
}, context)

Input

  • input object
    • RETENTION_POLICY_ASSIGNMENT_ID required string

Output

search

The search endpoint provides a powerful way of finding items that are accessible by a single user or an entire enterprise. Leverage the parameters listed below to generate targeted advanced searches.

box_content.search({
  "query": ""
}, context)

Input

  • input object
    • query required string: The string to search for; can be matched against item names, descriptions, text content of a file, and other fields of the different item types.
    • scope string: The scope for which you want to limit your search to. Can be user_content for a search limited to only the current user or enterprise_content for the entire enterprise. To enable the enterprise_content scope for an administrator, please contact us.
    • file_extensions string: Limit searches to specific file extensions like pdf,png,doc. Requires one or a set of comma delimited file extensions: file_extension_1,file_extension_2,....
    • created_at_range string: The date for when the item was created. Specify the date range by using RFC3339 timestamp variables separated by a comma: from_date,to_date (e.g 2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00). Trailing from_date, and leading ,to_date commas are also accepted, where the current date and earliest known date will be designated respectively.
    • updated_at_range string: The date for when the item was last updated. Specify the date range by using RFC3339 variables separated by a comma: from_date,to_date(e.g 2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00). Trailing from_date, and leading ,to_date commas are also accepted, where the current date and earliest known date will be designated respectively.
    • size_range integer: Filter by a file size range. Specify the file size range in bytes separated by a comma:lower_bound_size,upper_bound_size, where 1MB is equivalent to 1000000 bytes. Trailing lower_bound_size, and leading ,upper_bound_size commas are also accepted as parameters.
    • owner_user_ids string: Search by item owners. Requires one or a set of comma delimited user_ids: user_id_1,user_id_2,...
    • ancestor_folder_ids string: Limit searches to specific parent folders. Requires one or a set of comma delimited folder_ids: folder_id_1,folder_id_2,.... Parent folder results will also include items within subfolders.
    • content_types string: Limit searches to specific Box designated content types. Can be name, description, file_content, comments, or tags. Requires one or a set of comma delimited content_types: content_type_1,content_type_2,....
    • type string (values: file, folder, web_link): The type you want to return in your search. Can be file, folder, or web_link.
    • trash_content string: Allows you to search within the trash. Can be trashed_only or non_trashed_only. Searches without this parameter default to non_trashed_only.
    • mdfilters string: Filters for a specific metadata template for files with metadata object associations. The filters are to be placed in a single JSON object. Please refer the MDFilters object in the definitions section of the swagger.json
    • limit integer: Number of search results to return. The default is 30 and the max is 200.
    • offset integer: The search result at which to start the response. The default is 0.

Output

getSharedItems

Shared items are any files or folders that are represented by a shared link. Shared items are different from other API resources in that a shared resource doesn’t necessarily have to be in the account of the user accessing it. The actual shared link itself is used along with a normal access token. Used to retrieve the metadata about a shared item when only given a shared link. Because of varying permission for shared links, a password may be required to retrieve the shared item. Once the item has been retrieved, you can make API requests against the actual resource /files/{id} or /folders/{id} as long as the shared link and optional password are in the header.

box_content.getSharedItems({
  "BoxApi": ""
}, context)

Input

  • input object
    • BoxApi required string: The usage is 'BoxApi: shared_link=SHARED_LINK&shared_link_password=SHARED_LINK_PASSWORD'

Output

  • output object

createTaskAssignment

Used to assign a task to a single user. There can be multiple assignments on a given task.

box_content.createTaskAssignment({
  "body": {}
}, context)

Input

Output

deleteTaskAssignment

Deletes a specific task assignment.

box_content.deleteTaskAssignment({
  "TASK_ASSIGNMENT_ID": ""
}, context)

Input

  • input object
    • TASK_ASSIGNMENT_ID required string

Output

Output schema unknown

getTaskAssignment

Fetches a specific task assignment.

box_content.getTaskAssignment({
  "TASK_ASSIGNMENT_ID": ""
}, context)

Input

  • input object
    • TASK_ASSIGNMENT_ID required string
    • fields string: Attribute(s) to include in the response

Output

updateTaskAssignment

Used to update a task assignment.

box_content.updateTaskAssignment({
  "TASK_ASSIGNMENT_ID": "",
  "body": {}
}, context)

Input

  • input object

Output

createTask

Used to create a single task for single user on a single file.

box_content.createTask({
  "body": {}
}, context)

Input

  • input object
    • body required Task

Output

deleteTask

Permanently deletes a specific task.

box_content.deleteTask({
  "TASK_ID": ""
}, context)

Input

  • input object
    • TASK_ID required string

Output

Output schema unknown

getTask

Fetches a specific task.

box_content.getTask({
  "TASK_ID": ""
}, context)

Input

  • input object
    • TASK_ID required string
    • fields string: Attribute(s) to include in the response

Output

updateTask

Updates a specific task.

box_content.updateTask({
  "TASK_ID": "",
  "body": {}
}, context)

Input

  • input object
    • TASK_ID required string
    • fields string: Attribute(s) to include in the response
    • body required Task

Output

getTaskAssignments

Retrieves all of the assignments for a given task.

box_content.getTaskAssignments({
  "TASK_ID": ""
}, context)

Input

  • input object
    • TASK_ID required string
    • fields string: Attribute(s) to include in the response

Output

getEnterpriseUsers

Returns a list of all users for the Enterprise along with their user_id, public_name, and login.

box_content.getEnterpriseUsers({}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • filter_term string: A string used to filter the results to only users starting with the filter_term in either the name or the login.
    • limit integer: The number of records to return. The default is 100 and the max is 1000.
    • offset integer: The record at which to start. The default is 0.
    • user_type string (values: all, external, managed): The type of user to search for. Valid values are all, external or managed. If nothing is provided, the default behavior will be managed only

Output

createUser

Used to provision a new user in an enterprise. This method only works for enterprise admins.

box_content.createUser({
  "body": {}
}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response
    • body required User

Output

getCurrentUser

Retrieves information about the user who is currently logged in i.e. the user for whom this auth token was generated.

box_content.getCurrentUser({}, context)

Input

  • input object
    • fields string: Attribute(s) to include in the response

Output

deleteUser

Deletes a user in an enterprise account.

box_content.deleteUser({
  "USER_ID": ""
}, context)

Input

  • input object
    • USER_ID required string
    • notify boolean
    • force boolean

Output

Output schema unknown

getUser

Retrieves information about a user in the enterprise. Requires enterprise administration authorization.

box_content.getUser({
  "USER_ID": ""
}, context)

Input

  • input object
    • USER_ID required string
    • fields string: Attribute(s) to include in the response

Output

updateUser

Used to edit the settings and information about a user. This method only works for enterprise admins. To roll a user out of the enterprise (and convert them to a standalone free user), update the special enterprise attribute to be null.

Used to convert one of the user’s confirmed email aliases into the user’s primary login.

box_content.updateUser({
  "USER_ID": "",
  "body": {}
}, context)

Input

  • input object
    • USER_ID required string
    • fields string: Attribute(s) to include in the response
    • body required User

Output

getEmailAliases

Retrieves all email aliases for this user. The collection of email aliases does not include the primary login for the user; use GET /users/USER_ID to retrieve the login email address.

box_content.getEmailAliases({
  "USER_ID": ""
}, context)

Input

  • input object
    • USER_ID required string

Output

addEmailAlias

Adds a new email alias to the given user’s account.

box_content.addEmailAlias({
  "USER_ID": "",
  "body": {}
}, context)

Input

  • input object
    • USER_ID required string
    • body required EmailAlias

Output

deleteUserEmailAlias

Removes an email alias from a user.

box_content.deleteUserEmailAlias({
  "USER_ID": "",
  "EMAIL_ALIAS_ID": ""
}, context)

Input

  • input object
    • USER_ID required string
    • EMAIL_ALIAS_ID required string

Output

Output schema unknown

updateUserFolder

Moves all of the owned content from within one user’s folder into a new folder in another user’s account. You can move folders across users as long as the you have administrative permissions and the ‘source’ user owns the folders. To move everything from the root folder, use “0” which always represents the root folder of a Box account.

box_content.updateUserFolder({
  "USER_ID": "",
  "FOLDER_ID": "",
  "body": {}
}, context)

Input

  • input object
    • USER_ID required string
    • FOLDER_ID required string
    • notify boolean
    • fields string: Attribute(s) to include in the response
    • body required Folder

Output

getUserGroupMembership

Retrieves all of the group memberships for a given user. Note this is only available to group admins. To retrieve group memberships for the user making the API request, use the users/me/memberships endpoint.

box_content.getUserGroupMembership({
  "USER_ID": ""
}, context)

Input

  • input object
    • USER_ID required string
    • fields string: Attribute(s) to include in the response
    • limit integer: Default is 100. Max is 1000
    • offset integer: The item at which to begin the response

Output

createWebLink

Creates a web link object within a given folder.

box_content.createWebLink({
  "body": {}
}, context)

Input

  • input object

Output

deleteWebLink

Deletes a web link and moves it to the trash

box_content.deleteWebLink({
  "WEB_LINK_ID": ""
}, context)

Input

  • input object
    • WEB_LINK_ID required string

Output

Output schema unknown

getWebLink

Use to get information about the web link.

box_content.getWebLink({
  "WEB_LINK_ID": ""
}, context)

Input

  • input object
    • WEB_LINK_ID required string
    • fields string: Attribute(s) to include in the response

Output

updateWebLink

Updates information for a web link.

box_content.updateWebLink({
  "WEB_LINK_ID": "",
  "body": {}
}, context)

Input

  • input object
    • WEB_LINK_ID required string
    • fields string: Attribute(s) to include in the response
    • body required WebLink

Output

getWebhooks

Returns all defined webhooks for the requesting application and user, up to the limit. If no limit is supplied then Box uses the default limit of 100. If more than limit webhooks are defined then Box returns the webhooks in batches. When the results are batched, Box sends limit webhooks along with a next_marker field in the response object. The value of the next_marker field is a marker string that you can use in later requests to tell Box which batch to send next. When you send a request that includes a marker string, Box sends the next batch of webhooks, beginning after the last webhook of the previous batch. When the response contains the last of the defined webhooks, Box omits the next_marker field from its response. You can use limit and marker together with the marker string returned in the next_marker field to paginate lists of webhooks.

box_content.getWebhooks({}, context)

Input

  • input object
    • limit integer: The maximum number of webhooks to return per page
    • marker string: A marker string returned by Box if the result contains less than the full number of webhooks that are defined

Output

createWebhook

Create Webhook

box_content.createWebhook({
  "body": {}
}, context)

Input

  • input object

Output

deleteWebhook

Permanently deletes a webhook

box_content.deleteWebhook({
  "WEBHOOK_ID": ""
}, context)

Input

  • input object
    • WEBHOOK_ID required string

Output

Output schema unknown

getWebhook

Get a Webhook

box_content.getWebhook({
  "WEBHOOK_ID": ""
}, context)

Input

  • input object
    • WEBHOOK_ID required string

Output

updateWebhook

Update a Webhook

box_content.updateWebhook({
  "WEBHOOK_ID": "",
  "body": {}
}, context)

Input

  • input object
    • WEBHOOK_ID required string
    • body required Webhook

Output

Definitions

AssignmentCounts

  • AssignmentCounts object: Counts of assignments within this policy by apply-to type.
    • file integer
    • file_version integer
    • folder integer
    • user integer

BoxFile

  • File Object object: File information describe file objects in Box, with attributes like who created the file, when it was last modified, and other information. The actual content of the file itself is accessible through the /files/{id}/content endpoint.
    • id string
    • type string (values: folder, file, user, file_version, lock, collaboration, comment, task, web_link, collection, task_assignment, event, realtime_server, webhook_event, webhook, enterprise, invite, email_alias, group, group_membership, device_pinner, retention_policy, retention_policy_assignment, file_version_retention, legal_hold_policy, legal_hold_policy_assignment, legal_hold, upload_session)
    • etag string: A unique string identifying the version of this folder.
    • name string: The name of the folder.
    • sequence_id string: A unique ID for use with the /events endpoint.
    • sha1 string: The sha1 hash of this file.
    • collections array
    • comment_count integer: The number of comments on a file.
    • content_created_at string: When the content of this file was created (more info).
    • content_modified_at string: When the content of this file was last modified (more info).
    • created_at string: When this file was created on Box’s servers.
    • created_by UserReference
    • description string: The description of this file.
    • expiring_embed_link string: An expiring URL for an embedded preview session in an iframe. This URL will expire after 60 seconds and the session will expire after 60 minutes.
    • extension string: Indicates the suffix, when available, on the file. By default, set to an empty string. The suffix usually indicates the encoding (file format) of the file contents or usage.
    • file_version FileVersionReference
    • is_package boolean: Whether the file is a package. Used for Mac Packages used by iWorks.
    • item_status string: Whether this item is deleted or not.
    • lock Lock
    • modified_at string: When this file was last updated on the Box servers.
    • modified_by UserReference
    • owned_by UserReference
    • parent ItemReference
    • path_collection PathCollection
    • permissions FilePermissions
    • purged_at string: When this file will be permanently deleted.
    • shared_link SharedLink
    • size integer: Size of this file in bytes.
    • tags array: All tags applied to this file.
      • items string
    • trashed_at string: When this file was last moved to the trash.
    • version_number string: The version number of the file.
    • watermark_info WatermarkInfo

ChunkPagination

  • ChunkPagination object
    • chunk_size integer
    • next_stream_position string

Collaboration

  • Collaboration object: Collaborations are used to set and apply access permissions for users and groups to files and folders, similar to access control lists.
    • id string
    • type string (values: folder, file, user, file_version, lock, collaboration, comment, task, web_l