flowground für Geschäftskunden

Technische Spezifikationen

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

getPendingCollaborations

Used to retrieve all pending collaboration invites for this user.

OnInit
./lib/actions/getPendingCollaborations.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/createCollaboration.js
OnStartup
-
OnClose
-

Attributes

-

deleteCollaboration

Used to delete a single collaboration.

OnInit
./lib/actions/deleteCollaboration.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getCollaboration.js
OnStartup
-
OnClose
-

Attributes

-

updateCollaboation

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

OnInit
./lib/actions/updateCollaboation.js
OnStartup
-
OnClose
-

Attributes

-

getCollections

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

OnInit
./lib/actions/getCollections.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/getCollectionItems.js
OnStartup
-
OnClose
-

Attributes

-

createComment

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

OnInit
./lib/actions/createComment.js
OnStartup
-
OnClose
-

Attributes

-

deleteComment

Permanently deletes a comment.

OnInit
./lib/actions/deleteComment.js
OnStartup
-
OnClose
-

Attributes

-

getComment

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

OnInit
./lib/actions/getComment.js
OnStartup
-
OnClose
-

Attributes

-

updateComment

Used to update the message of the comment.

OnInit
./lib/actions/updateComment.js
OnStartup
-
OnClose
-

Attributes

-

deleteDevicePin

Delete individual device pin.

OnInit
./lib/actions/deleteDevicePin.js
OnStartup
-
OnClose
-

Attributes

-

getDevicePin

Gets information about an individual device pin.

OnInit
./lib/actions/getDevicePin.js
OnStartup
-
OnClose
-

Attributes

-

getEnterpriseDevicePins

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

OnInit
./lib/actions/getEnterpriseDevicePins.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getUserEvents.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/eventLongPolling.js
OnStartup
-
OnClose
-

Attributes

-

getFileVersionLegalHoldPolicies

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

OnInit
./lib/actions/getFileVersionLegalHoldPolicies.js
OnStartup
-
OnClose
-

Attributes

-

getFileVersionLegalHoldPolicy

Get details of a single File Version Legal Hold.

OnInit
./lib/actions/getFileVersionLegalHoldPolicy.js
OnStartup
-
OnClose
-

Attributes

-

getFileVersionRetentions

Retrieves all file version retentions for the given enterprise.

OnInit
./lib/actions/getFileVersionRetentions.js
OnStartup
-
OnClose
-

Attributes

-

getFileVersionRetention

Used to retrieve information about a file version retention

OnInit
./lib/actions/getFileVersionRetention.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/fileUploadPreflightCheck.js
OnStartup
-
OnClose
-

Attributes

-

deleteFile

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

OnInit
./lib/actions/deleteFile.js
OnStartup
-
OnClose
-

Attributes

-

getFile

Used to retrieve the metadata about a file.

OnInit
./lib/actions/getFile.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/restoreTrashedFile.js
OnStartup
-
OnClose
-

Attributes

-

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}

OnInit
./lib/actions/updateFileInfo.js
OnStartup
-
OnClose
-

Attributes

-

getFileCollaborations

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

OnInit
./lib/actions/getFileCollaborations.js
OnStartup
-
OnClose
-

Attributes

-

getFileComments

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

OnInit
./lib/actions/getFileComments.js
OnStartup
-
OnClose
-

Attributes

-

getFileContent

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

OnInit
./lib/actions/getFileContent.js
OnStartup
-
OnClose
-

Attributes

-

copyFile

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

OnInit
./lib/actions/copyFile.js
OnStartup
-
OnClose
-

Attributes

-

getAllFileMetadata

Used to retrieve all metadata associated with a given file

OnInit
./lib/actions/getAllFileMetadata.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/deleteFileMetadata.js
OnStartup
-
OnClose
-

Attributes

-

getFileMetadata

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

OnInit
./lib/actions/getFileMetadata.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/createFileMetadata.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/updateFileMetadata.js
OnStartup
-
OnClose
-

Attributes

-

getFileTasks

Retrieves all of the tasks for given file.

OnInit
./lib/actions/getFileTasks.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getFileThumbnail.js
OnStartup
-
OnClose
-

Attributes

-

deleteTrashedFile

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

OnInit
./lib/actions/deleteTrashedFile.js
OnStartup
-
OnClose
-

Attributes

-

getTrashedFile

Retrieves an item that has been moved to the trash.

OnInit
./lib/actions/getTrashedFile.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/getFileVersions.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/promotoeFileVersion.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/deleteFileVersion.js
OnStartup
-
OnClose
-

Attributes

-

deleteFileWatermark

Used to remove the watermark for a corresponding Box file.

OnInit
./lib/actions/deleteFileWatermark.js
OnStartup
-
OnClose
-

Attributes

-

getFileWatermark

Used to retrieve the watermark for a corresponding Box file.

OnInit
./lib/actions/getFileWatermark.js
OnStartup
-
OnClose
-

Attributes

-

updateFileWatermark

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

OnInit
./lib/actions/updateFileWatermark.js
OnStartup
-
OnClose
-

Attributes

-

createFolder

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

OnInit
./lib/actions/createFolder.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getTrashedItems.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/deleteFolder.js
OnStartup
-
OnClose
-

Attributes

-

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

OnInit
./lib/actions/getFolder.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/restoreTrashedFolder.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/updateFolder.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getFolderCollaborations.js
OnStartup
-
OnClose
-

Attributes

-

copyFolder

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

OnInit
./lib/actions/copyFolder.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getFolderItems.js
OnStartup
-
OnClose
-

Attributes

-

getAllFolderMetadata

Used to retrieve all metadata associated with a given folder

OnInit
./lib/actions/getAllFolderMetadata.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/deleteFolderMetadata.js
OnStartup
-
OnClose
-

Attributes

-

getFolderMetadata

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

OnInit
./lib/actions/getFolderMetadata.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/createFolderMetadata.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/updateFolderMetadata.js
OnStartup
-
OnClose
-

Attributes

-

deleteTrashedFolder

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

OnInit
./lib/actions/deleteTrashedFolder.js
OnStartup
-
OnClose
-

Attributes

-

getTrashedFolder

Retrieves an folder that has been moved to the trash.

OnInit
./lib/actions/getTrashedFolder.js
OnStartup
-
OnClose
-

Attributes

-

deleteFolderWatermark

Used to remove the watermark for a corresponding Box Folder.

OnInit
./lib/actions/deleteFolderWatermark.js
OnStartup
-
OnClose
-

Attributes

-

getFolderWatermark

Used to retrieve the watermark for a corresponding Box folder.

OnInit
./lib/actions/getFolderWatermark.js
OnStartup
-
OnClose
-

Attributes

-

updateFolderWatermark

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

OnInit
./lib/actions/updateFolderWatermark.js
OnStartup
-
OnClose
-

Attributes

-

createGroupMembership

Used to add a member to a Group.

OnInit
./lib/actions/createGroupMembership.js
OnStartup
-
OnClose
-

Attributes

-

deleteGroupMembership

Deletes a specific group membership.

OnInit
./lib/actions/deleteGroupMembership.js
OnStartup
-
OnClose
-

Attributes

-

getGroupMembership

Fetches a specific group membership entry.

OnInit
./lib/actions/getGroupMembership.js
OnStartup
-
OnClose
-

Attributes

-

updateGroupMembership

Used to update a group membership.

OnInit
./lib/actions/updateGroupMembership.js
OnStartup
-
OnClose
-

Attributes

-

getEnterpriseGroups

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

OnInit
./lib/actions/getEnterpriseGroups.js
OnStartup
-
OnClose
-

Attributes

-

createGroup

Used to create a group.

OnInit
./lib/actions/createGroup.js
OnStartup
-
OnClose
-

Attributes

-

deleteGroup

Permanently deletes a specific group.

OnInit
./lib/actions/deleteGroup.js
OnStartup
-
OnClose
-

Attributes

-

getGroup

Used to get information about a group.

OnInit
./lib/actions/getGroup.js
OnStartup
-
OnClose
-

Attributes

-

updateGroup

Updates a specific group.

OnInit
./lib/actions/updateGroup.js
OnStartup
-
OnClose
-

Attributes

-

getGroupCollaborations

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

OnInit
./lib/actions/getGroupCollaborations.js
OnStartup
-
OnClose
-

Attributes

-

getGroupMemberships

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

OnInit
./lib/actions/getGroupMemberships.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/createInvite.js
OnStartup
-
OnClose
-

Attributes

-

getInvite

OnInit
./lib/actions/getInvite.js
OnStartup
-
OnClose
-

Attributes

-

getLegalHoldPolicies

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

OnInit
./lib/actions/getLegalHoldPolicies.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/createLegalHoldPolicy.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/deleteLegalHoldPolicy.js
OnStartup
-
OnClose
-

Attributes

-

getLegalHoldPolicy

Get details of a single Legal Hold Policy

OnInit
./lib/actions/getLegalHoldPolicy.js
OnStartup
-
OnClose
-

Attributes

-

updateLegalHoldPolicy

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

OnInit
./lib/actions/updateLegalHoldPolicy.js
OnStartup
-
OnClose
-

Attributes

-

getLegalHoldPolicyAssignments

Get list of assignments for a single Policy.

OnInit
./lib/actions/getLegalHoldPolicyAssignments.js
OnStartup
-
OnClose
-

Attributes

-

createLegalHoldPolicyAssignment

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

OnInit
./lib/actions/createLegalHoldPolicyAssignment.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/deleteLegalHoldPolicyAssignment.js
OnStartup
-
OnClose
-

Attributes

-

getLegalHoldPolicyAssignment

Get details of a single assignment.

OnInit
./lib/actions/getLegalHoldPolicyAssignment.js
OnStartup
-
OnClose
-

Attributes

-

createMetadataTemplate

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

OnInit
./lib/actions/createMetadataTemplate.js
OnStartup
-
OnClose
-

Attributes

-

getEnterpriseMetadataTemplates

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

OnInit
./lib/actions/getEnterpriseMetadataTemplates.js
OnStartup
-
OnClose
-

Attributes

-

getMetadataTemplate

Used to retrieve the schema for a given metadata template.

OnInit
./lib/actions/getMetadataTemplate.js
OnStartup
-
OnClose
-

Attributes

-

updateMetadataTemplate

Used to update the schema of an existing template.

OnInit
./lib/actions/updateMetadataTemplate.js
OnStartup
-
OnClose
-

Attributes

-

getRetentionPolicies

Retrieves all of the retention policies for the given enterprise.

OnInit
./lib/actions/getRetentionPolicies.js
OnStartup
-
OnClose
-

Attributes

-

createRetentionPolicy

Used to create a new retention policy.

OnInit
./lib/actions/createRetentionPolicy.js
OnStartup
-
OnClose
-

Attributes

-

getRetentionPolicy

Used to retrieve information about a retention policy

OnInit
./lib/actions/getRetentionPolicy.js
OnStartup
-
OnClose
-

Attributes

-

updateRetentionPolicy

Used to update a retention policy.

OnInit
./lib/actions/updateRetentionPolicy.js
OnStartup
-
OnClose
-

Attributes

-

getRetentionPolicyAssignments

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

OnInit
./lib/actions/getRetentionPolicyAssignments.js
OnStartup
-
OnClose
-

Attributes

-

createRetentionPolicyAssignment

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

OnInit
./lib/actions/createRetentionPolicyAssignment.js
OnStartup
-
OnClose
-

Attributes

-

getRetentionPolicyAssignment

Used to retrieve information about a retention policy assignment.

OnInit
./lib/actions/getRetentionPolicyAssignment.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/search.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getSharedItems.js
OnStartup
-
OnClose
-

Attributes

-

createTaskAssignment

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

OnInit
./lib/actions/createTaskAssignment.js
OnStartup
-
OnClose
-

Attributes

-

deleteTaskAssignment

Deletes a specific task assignment.

OnInit
./lib/actions/deleteTaskAssignment.js
OnStartup
-
OnClose
-

Attributes

-

getTaskAssignment

Fetches a specific task assignment.

OnInit
./lib/actions/getTaskAssignment.js
OnStartup
-
OnClose
-

Attributes

-

updateTaskAssignment

Used to update a task assignment.

OnInit
./lib/actions/updateTaskAssignment.js
OnStartup
-
OnClose
-

Attributes

-

createTask

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

OnInit
./lib/actions/createTask.js
OnStartup
-
OnClose
-

Attributes

-

deleteTask

Permanently deletes a specific task.

OnInit
./lib/actions/deleteTask.js
OnStartup
-
OnClose
-

Attributes

-

getTask

Fetches a specific task.

OnInit
./lib/actions/getTask.js
OnStartup
-
OnClose
-

Attributes

-

updateTask

Updates a specific task.

OnInit
./lib/actions/updateTask.js
OnStartup
-
OnClose
-

Attributes

-

getTaskAssignments

Retrieves all of the assignments for a given task.

OnInit
./lib/actions/getTaskAssignments.js
OnStartup
-
OnClose
-

Attributes

-

getEnterpriseUsers

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

OnInit
./lib/actions/getEnterpriseUsers.js
OnStartup
-
OnClose
-

Attributes

-

createUser

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

OnInit
./lib/actions/createUser.js
OnStartup
-
OnClose
-

Attributes

-

getCurrentUser

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

OnInit
./lib/actions/getCurrentUser.js
OnStartup
-
OnClose
-

Attributes

-

deleteUser

Deletes a user in an enterprise account.

OnInit
./lib/actions/deleteUser.js
OnStartup
-
OnClose
-

Attributes

-

getUser

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

OnInit
./lib/actions/getUser.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/updateUser.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getEmailAliases.js
OnStartup
-
OnClose
-

Attributes

-

addEmailAlias

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

OnInit
./lib/actions/addEmailAlias.js
OnStartup
-
OnClose
-

Attributes

-

deleteUserEmailAlias

Removes an email alias from a user.

OnInit
./lib/actions/deleteUserEmailAlias.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/updateUserFolder.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getUserGroupMembership.js
OnStartup
-
OnClose
-

Attributes

-

createWebLink

Creates a web link object within a given folder.

OnInit
./lib/actions/createWebLink.js
OnStartup
-
OnClose
-

Attributes

-

deleteWebLink

Deletes a web link and moves it to the trash

OnInit
./lib/actions/deleteWebLink.js
OnStartup
-
OnClose
-

Attributes

-

getWebLink

Use to get information about the web link.

OnInit
./lib/actions/getWebLink.js
OnStartup
-
OnClose
-

Attributes

-

updateWebLink

Updates information for a web link.

OnInit
./lib/actions/updateWebLink.js
OnStartup
-
OnClose
-

Attributes

-

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.

OnInit
./lib/actions/getWebhooks.js
OnStartup
-
OnClose
-

Attributes

-

createWebhook

Create Webhook

OnInit
./lib/actions/createWebhook.js
OnStartup
-
OnClose
-

Attributes

-

deleteWebhook

Permanently deletes a webhook

OnInit
./lib/actions/deleteWebhook.js
OnStartup
-
OnClose
-

Attributes

-

getWebhook

Get a Webhook

OnInit
./lib/actions/getWebhook.js
OnStartup
-
OnClose
-

Attributes

-

updateWebhook

Update a Webhook

OnInit
./lib/actions/updateWebhook.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-