Overview
Configuration is provided for establishing connections with the Box service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Demonstration
Quick Start
In this QS, we will show you step-by-step how to create a connection to a Box REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection Managers tab and select New Connection. Then "Add SSIS Connection Manager" popup window opens, scroll down and select "Connection managers for REST Connection" then click Add.
Step 2. From the Configuration drop down menu select Box.
Step 3. For successful authentication you need to obtain authentication token from the service. To do so, click the New button placed inside the Token file grid row and follow the wizard.
Step 3.1. Choose a Browser Engine and click Next.
Step 3.2. Provide authentication details (email and password) for your Box account and then click Authorize.
Step 3.3. Save your password protected Box access token file and click OK.
Step 4. Test your connection by clicking Test Connection button.
Step 5. Click on OK button.
Congratulations! You have successfully created a connection to a Box REST API using COZYROC's REST Connection Manager.
Configuration
Base URL address: https://api.box.com/2.0.
- OAuth 2.0
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- client_id: Required. The client ID or API key for the application
- client_secret: Required. The client secret or API secret for the application
- redirect_uri: Required. The redirect URL for your application that a user will be sent to after they have authorized the application
- scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.box.com/guides/authentication/oauth2/.
- Client Credentials Grant
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client ID.
- client_secret: Required. Specify client secret.
- box_subject_type: Required. Specify Box subject type (enterprise or user).
- box_subject_id: Required. Specify Box subject id.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.box.com/guides/authentication/client-credentials/.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/metadata_cascade_policies.The action has the following user-defined parameters:
- folder_id: Required. Specifies which folder to return policies for. This can not be used on the root folder with ID `0`.
- owner_enterprise_id: The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise.
Documentation: https://developer.box.com/reference/get-metadata-cascade-policies/.
- [Read single] action
-
Endpoint URL address:
/metadata_cascade_policies/{{=parameters.metadata_cascade_policy_id}}.The action has the following user-defined parameters:
- metadata_cascade_policy_id: Required. The ID of the metadata cascade policy.
Documentation: https://developer.box.com/reference/get-metadata-cascade-policies-id/.
- [Create] action
-
Endpoint URL address:
/metadata_cascade_policies.Documentation: https://developer.box.com/reference/post-metadata-cascade-policies/.
- [Delete] action
-
Endpoint URL address:
/metadata_cascade_policies/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-metadata-cascade-policies-id/.
The resource includes the fields from the ObjectBaseT template.
- owner_enterprise
Template: ObjectBaseT.
- parent
Template: ObjectBaseT.
- scope
Template: ShortText.
- templateKey
Template: ShortText.
- folder_id
Template: ShortText.
- conflict_resolution
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks/{{=parameters.task_id}}/assignments.The action has the following user-defined parameters:
- task_id: Required. The ID of the task.
Documentation: https://developer.box.com/reference/get-tasks-id-assignments/.
- [Read single] action
-
Endpoint URL address:
/task_assignments/{{=parameters.task_assignment_id}}.The action has the following user-defined parameters:
- task_assignment_id: Required. The ID of the task assignment.
Documentation: https://developer.box.com/reference/get-task-assignments-id/.
- [Create] action
-
Endpoint URL address:
/task_assignments.Documentation: https://developer.box.com/reference/post-task-assignments/.
- [Update] action
-
Endpoint URL address:
/task_assignments/{{=item.id}}.Documentation: https://developer.box.com/reference/put-task-assignments-id/.
- [Delete] action
-
Endpoint URL address:
/task_assignments/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-task-assignments-id/.
The resource includes the fields from the TaskAssignment template.
- task
Template: ObjectBaseT.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/retention_policies/{{=parameters.retention_policy_id}}/assignments.The action has the following user-defined parameters:
- retention_policy_id: Required. The ID of the retention policy.
- type: The type of the retention policy assignment to retrieve.
Documentation: https://developer.box.com/reference/get-retention-policies-id-assignments/.
- [Read single] action
-
Endpoint URL address:
/retention_policy_assignments/{{=parameters.retention_policy_assignment_id}}.The action has the following user-defined parameters:
- retention_policy_assignment_id: Required. The ID of the retention policy assignment.
Documentation: https://developer.box.com/reference/get-retention-policy-assignments-id/.
- [Create] action
-
Endpoint URL address:
/retention_policy_assignments.Documentation: https://developer.box.com/reference/post-retention-policy-assignments/.
- [Delete] action
-
Endpoint URL address:
/retention_policy_assignments/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-retention-policy-assignments-id/.
The resource includes the fields from the ObjectBaseT template.
- policy_id
Template: ShortText.
- assign_to
Template: ObjectBaseT.
- filter_fields
Field components:
- An array.
- Contains the following components: field, value.
- start_date_field
Template: ShortText.
- files_under_retention
The value is gathered from
/retention_policy_assignments/{{=item.id}}/files_under_retentionaddress. Field components:- An array.
-
Uses template:
File--Mini.
- file_versions_under_retention
The value is gathered from
/retention_policy_assignments/{{=item.id}}/file_versions_under_retentionaddress. Field components:- An array.
-
Uses template:
File--Mini.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/files/{{=parameters.file_id}}/metadata/global/boxSkillsCards.
The result is extracted from:{{=response.cards}}.The action has the following user-defined parameters:
- file_id: Required. The unique identifier that represents a file.
Documentation: https://developer.box.com/reference/get-files-id-metadata-global-boxSkillsCards/.
- [Create] action
-
Endpoint URL address:
/files/{{=parameters.file_id}}/metadata/global/boxSkillsCards.The action has the following user-defined parameters:
- file_id: Required. The unique identifier that represents a file.
The following request parameters will be automatically processed:
-
application/json:
{{={ cards: batch } }}
Documentation: https://developer.box.com/reference/post-files-id-metadata-global-boxSkillsCards/.
- [Update] action
-
Endpoint URL address:
/files/{{=item.file_id}}/metadata/global/boxSkillsCards.The following request parameters will be automatically processed:
-
application/json:
{{=_.map(batch, function(item, index) { return { op: 'replace', path: '/cards/' + index, value: item }; })}}
Documentation: https://developer.box.com/reference/put-files-id-metadata-global-boxSkillsCards/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/files/{{=item.file_id}}/metadata/global/boxSkillsCards.Documentation: https://developer.box.com/reference/delete-files-id-metadata-global-boxSkillsCards/.
- type
Template: ShortText.
- created_at
Template: DateTime.
- skill_card_type
Template: ShortText.
- skill_card_title
Field components:
-
Uses template:
ShortText. - Contains the following components: code, message.
-
Uses template:
- skill
Template: ObjectBaseT.
- invocation
Template: ObjectBaseT.
- entries
Field components:
- An array.
- Contains the following components: text, appears, image_url.
- duration
Data type: DT_I4
- status
Field components:
-
Uses template:
ShortText. - Contains the following components: code, message.
-
Uses template:
- file_id
Template: ShortText.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/sign_requests.Documentation: https://developer.box.com/reference/get-sign-requests/.
- [Read single] action
-
Endpoint URL address:
/sign_requests/{{=parameters.sign_request_id}}.The action has the following user-defined parameters:
- sign_request_id: Required. The ID of the sign request
Documentation: https://developer.box.com/reference/get-sign-requests-id/.
- [Create] action
-
Endpoint URL address:
/sign_requests.Documentation: https://developer.box.com/reference/post-sign-requests/.
- [Delete] action
-
Endpoint URL address:
/sign_requests/{{=item.id}}/cancel.
The action uses POST method.Documentation: https://developer.box.com/reference/post-sign-requests-id-cancel/.
The resource includes the fields from the SignRequest template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/shield_information_barriers.Documentation: https://developer.box.com/reference/get-shield-information-barriers/.
- [Read single] action
-
Endpoint URL address:
/shield_information_barriers/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the shield information barrier.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-reports-id/.
- [Create] action
-
Endpoint URL address:
/shield_information_barriers.Documentation: https://developer.box.com/reference/post-shield-information-barrier-reports/.
The resource includes the fields from the ShieldInformationBarrier template.
- reports
The gathered value is processed with
{{=connection.resourceManager['Shield Information Barrier Report'].getData({ parameters: ['shield_information_barrier_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ShieldInformationBarrierReport.
- segments
The gathered value is processed with
{{=connection.resourceManager['Shield Information Barrier Segment'].getData({ parameters: ['shield_information_barrier_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ShieldInformationBarrierSegment.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/collaborations.The action has the following user-defined parameters:
- status: Required. The status of the collaborations to retrieve
Documentation: https://developer.box.com/reference/get-collaborations/.
- [Read single] action
-
Endpoint URL address:
/collaborations/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the collaboration
Documentation: https://developer.box.com/reference/get-collaborations-id/.
- [Read file] action
-
Endpoint URL address:
/files/{{=parameters.file_id}}/collaborations.The action has the following user-defined parameters:
- file_id: Required. The unique identifier that represents a file.
Documentation: https://developer.box.com/reference/get-files-id-collaborations/.
- [Read folder] action
-
Endpoint URL address:
/folders/{{=parameters.folder_id}}/collaborations.The action has the following user-defined parameters:
- folder_id: Required. The unique identifier that represent a folder.
Documentation: https://developer.box.com/reference/get-folders-id-collaborations/.
- [Read group] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/collaborations.The action has the following user-defined parameters:
- group_id: Required. The ID of the group.
Documentation: https://developer.box.com/reference/get-groups-id-collaborations/.
- [Create] action
-
Endpoint URL address:
/collaborations.The action has the following user-defined parameters:
- notify: Determines if users should receive email notification for the action performed.
Documentation: https://developer.box.com/reference/post-collaborations/.
- [Update] action
-
Endpoint URL address:
/collaborations/{{=item.id}}.Documentation: https://developer.box.com/reference/put-collaborations-id/.
- [Delete] action
-
Endpoint URL address:
/collaborations/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-collaborations-id/.
The resource includes the fields from the Collaboration template.
- can_view_path
Data type: DT_BOOL
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/collaboration_whitelist_entries.Documentation: https://developer.box.com/reference/get-collaboration-whitelist-entries/.
- [Read single] action
-
Endpoint URL address:
/collaboration_whitelist_entries/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the entry in the list.
Documentation: https://developer.box.com/reference/get-collaboration-whitelist-entries-id/.
- [Create] action
-
Endpoint URL address:
/collaboration_whitelist_entries.Documentation: https://developer.box.com/reference/post-collaboration-whitelist-entries/.
- [Delete] action
-
Endpoint URL address:
/collaboration_whitelist_entries/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-collaboration-whitelist-entries-id/.
The resource includes the fields from the CollaborationAllowlistEntry template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/collaboration_whitelist_exempt_targets.Documentation: https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets/.
- [Read single] action
-
Endpoint URL address:
/collaboration_whitelist_exempt_targets/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the exemption to the list.
Documentation: https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets-id/.
- [Create] action
-
Endpoint URL address:
/collaboration_whitelist_exempt_targets.Documentation: https://developer.box.com/reference/post-collaboration-whitelist-exempt-targets/.
- [Delete] action
-
Endpoint URL address:
/collaboration_whitelist_exempt_targets/{{=parameters.id}}.Documentation: https://developer.box.com/reference/delete-collaboration-whitelist-exempt-targets-id/.
The resource includes the fields from the CollaborationAllowlistExemptTarget template.
- user
Field components:
-
Uses template:
ShortText. - Contains the following components: id.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/collections.Documentation: https://developer.box.com/reference/get-collections/.
The resource includes the fields from the ObjectBaseT template.
- items
The value is gathered from
/collections/{{=item.id}}/itemsaddress. The gathered value is processed with{{=response.entries}}expression. Field components:- An array.
-
Uses template:
Collection.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/files/{{=parameters.file_id}}/comments.The action has the following user-defined parameters:
- file_id: Required. The unique identifier that represents a file.
Documentation: https://developer.box.com/reference/get-files-id-comments/.
- [Read single] action
-
Endpoint URL address:
/comments/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the comment.
Documentation: https://developer.box.com/reference/get-comments-id/.
- [Create] action
-
Endpoint URL address:
/comments.Documentation: https://developer.box.com/reference/post-comments/.
- [Update] action
-
Endpoint URL address:
/comments/{{=item.id}}.Documentation: https://developer.box.com/reference/put-comments-id/.
- [Delete] action
-
Endpoint URL address:
/comments/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-comments-id/.
The resource includes the fields from the Comment template.
- message
Template: ShortText.
- tagged_message
Template: ShortText.
- item
Template: ObjectBaseT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/folders/{{=parameters.folder_id}}/items.
The result is extracted from:{{=_.filter( response.entries, function(item) { return item.type == 'file'; } )}}.The action has the following user-defined parameters:
- folder_id: Required. The unique identifier that represents a folder.
Documentation: https://developer.box.com/reference/get-folders-id-items/.
- [Read single] action
-
Endpoint URL address:
/files/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The unique identifier that represents a file.
- if-none-match: Ensures an item is only returned if it has changed.
- boxapi: The URL, and optional password, for the shared link of this item.
- x-rep-hints: A header required to request specific `representations` of a file.
The following request parameters will be automatically processed:
-
if-none-match:
{{=parameters.get('if-none-match')}} -
boxapi:
{{=parameters.get('boxapi')}} -
x-rep-hints:
{{=parameters.get('x-rep-hints')}}
Documentation: https://developer.box.com/reference/get-files-id/.
- [Read search] action
-
Endpoint URL address:
/search.The action has the following user-defined parameters:
- query: The string to search for.
The following request parameters will be automatically processed:
-
type:
file
Documentation: https://developer.box.com/reference/get-search/.
- [Read shared] action
-
Endpoint URL address:
/shared_items.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- boxapi: Required. A header containing the shared link and optional password for the shared link.
- if-none-match: Ensures an item is only returned if it has changed.
The following request parameters will be automatically processed:
-
boxapi:
{{=parameters.boxapi}} -
if-none-match:
{{=parameters.get('if-none-match')}}
Documentation: https://developer.box.com/reference/get-shared-items/.
- [Read trash] action
-
Endpoint URL address:
/folders/trash/items.
The result is extracted from:{{=_.filter( response.entries, function(item) { return item.type == 'file'; } )}}.The action has the following user-defined parameters:
- direction: The direction to sort results in.
- sort: Defines the **second** attribute by which items are sorted.
Documentation: https://developer.box.com/reference/get-folders-trash-items/.
- [Read recent] action
-
Endpoint URL address:
/recent_items.
The result is extracted from:{{=_.filter( _.map(response.entries, function(ri) { return _.extend(ri.item, ri); }), function(ri) { return ri.item.type == 'file'; } )}}.Documentation: https://developer.box.com/reference/get-recent-items/.
- [Update] action
-
Endpoint URL address:
/files/{{=item.id}}.The action has the following user-defined parameters:
- if-match: Ensures this item hasn't recently changed before making changes.
The following request parameters will be automatically processed:
-
if-match:
{{=parameters.get('if-match')}}
Documentation: https://developer.box.com/reference/put-files-id/.
- [Delete] action
-
Endpoint URL address:
/files/{{=item.id}}.The action has the following user-defined parameters:
- if-match: Ensures this item hasn't recently changed before making changes.
The following request parameters will be automatically processed:
-
if-match:
{{=parameters.get('if-match')}}
Documentation: https://developer.box.com/reference/delete-files-id/.
The resource includes the fields from the File--Full template.
- thumbnail
-
Field components:
- Contains the following components: 32, 64, 128, 256.
Documentation: https://developer.box.com/reference/get-files-id-thumbnail-id/.
- zip
Data type: DT_IMAGE The gathered value is processed with
{{=BOX.downloadZip({ id: item.id, type: 'file' })expression.- versions
The gathered value is processed with
{{=connection.resourceManager['File Version'].getData({ parameters: ['file_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
FileVersion--Full.
- metadata
The value is gathered from
/files/{{=item.id}}/metadataaddress. Field components:- An array.
-
Uses template:
Metadata.
- classification
Template: Classification. The value is gathered from
/files/{{=item.id}}/metadata/enterprise/securityClassification-6VMVochwUWoaddress.- tasks
The value is gathered from
/files/{{=item.id}}/tasksaddress. Field components:- An array.
-
Uses template:
Task.
- collaborations
The gathered value is processed with
{{=connection.resourceManager['Collaboration'].getData({ endpoint: 'file', parameters: ['file_id=' + item.id]})}}expression. Field components:- An array.
-
Uses template:
Collaboration.
- action
Field components:
-
Uses template:
SharedLinkT. - Contains the following components: copy, set_shared_link, add_metadata, update_metadata, delete_metadata, add_classification, update_classification.
-
Uses template:
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/folders/{{=parameters.folder_id}}/items.The action has the following user-defined parameters:
- folder_id: Required. The unique identifier that represent a folder.
- boxapi: The URL, and optional password, for the shared link of this item.
Documentation: https://developer.box.com/reference/get-folders-id-items/.
- [Read single] action
-
Endpoint URL address:
/folders/{{=parameters.folder_id}}.The action has the following user-defined parameters:
- folder_id: Required. The unique identifier that represent a folder.
- if-none-match: Ensures an item is only returned if it has changed.
- boxapi: The URL, and optional password, for the shared link of this item.
The following request parameters will be automatically processed:
-
if-none-match:
{{=parameters.get('if-none-match')}} -
boxapi:
{{=parameters.get('boxapi')}}
Documentation: https://developer.box.com/reference/get-folders-id/.
- [Read search] action
-
Endpoint URL address:
/search.The action has the following user-defined parameters:
- query: The string to search for.
The following request parameters will be automatically processed:
-
type:
folder
Documentation: https://developer.box.com/reference/get-search/.
- [Read shared] action
-
Endpoint URL address:
/shared_items.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- boxapi: Required. A header containing the shared link and optional password for the shared link.
- if-none-match: Ensures an item is only returned if it has changed.
The following request parameters will be automatically processed:
-
if-none-match:
{{=parameters.get('if-none-match')}} -
boxapi:
{{=parameters.get('boxapi')}}
Documentation: https://developer.box.com/reference/get-shared-items--folders/.
- [Read trash] action
-
Endpoint URL address:
/folders/trash/items.
The result is extracted from:{{=_.filter( response.entries, function(item) { return item.type == 'folder'; } )}}.The action has the following user-defined parameters:
- direction: The direction to sort results in.
- sort: Defines the **second** attribute by which items are sorted.
Documentation: https://developer.box.com/reference/get-folders-trash-items/.
- [Read recent] action
-
Endpoint URL address:
/recent_items.
The result is extracted from:{{=_.filter( _.map(response.entries, function(ri) { return _.extend(ri.item, ri); }), function(ri) { return ri.item.type == 'folder'; } )}}.Documentation: https://developer.box.com/reference/get-recent-items/.
- [Create] action
-
Endpoint URL address:
/folders.Documentation: https://developer.box.com/reference/post-folders/.
- [Update] action
-
Endpoint URL address:
/folders/{{=item.id}}.The action has the following user-defined parameters:
- if-match: Ensures this item hasn't recently changed before making changes.
The following request parameters will be automatically processed:
-
if-match:
{{=parameters.get('if-match')}}
Documentation: https://developer.box.com/reference/put-folders-id/.
- [Delete] action
-
Endpoint URL address:
/folders/{{=item.id}}.The action has the following user-defined parameters:
- if-match: Ensures this item hasn't recently changed before making changes.
- recursive: Delete a folder that is not empty by recursively deleting the folder and all of its content.
The following request parameters will be automatically processed:
-
if-match:
{{=parameters.get('if-match')}}
Documentation: https://developer.box.com/reference/delete-folders-id/.
The resource includes the fields from the Folder--Full template.
- collections
Field components:
- An array.
-
Uses template:
ObjectBaseT.
- items
The value is gathered from
/folders/{{=item.id}}/itemsaddress. Field components:- An array.
-
Uses template:
Folder--Mini.
- zip
Data type: DT_IMAGE The gathered value is processed with
{{=BOX.downloadZip({ id: item.id, type: 'folder' })expression.- metadata
The value is gathered from
/folders/{{=item.id}}/metadataaddress. Field components:- An array.
-
Uses template:
Metadata.
- classification
Template: Classification. The value is gathered from
/folders/{{=item.id}}/metadata/enterprise/securityClassification-6VMVochwUWoaddress.- collaborations
The gathered value is processed with
{{=connection.resourceManager['Collaboration'].getData({ endpoint: 'folder', parameters: ['folder_id=' + item.id]})}}expression. Field components:- An array.
-
Uses template:
Collaboration.
- action
Field components:
-
Uses template:
SharedLinkT. - Contains the following components: set_shared_link, add_metadata, update_metadata, delete_metadata, add_classification, update_classification.
-
Uses template:
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/file_requests/{{=parameters.file_request_id}}.The action has the following user-defined parameters:
- file_request_id: Required. The unique identifier that represent a file request.
Documentation: https://developer.box.com/reference/get-file-requests-id/.
- [Update] action
-
Endpoint URL address:
/file_requests/{{=item.id}}.The action has the following user-defined parameters:
- if-match: Ensures this item hasn't recently changed before making changes.
The following request parameters will be automatically processed:
-
if-match:
{{=parameters.get('if-match')}}
Documentation: https://developer.box.com/reference/put-file-requests-id/.
- [Delete] action
-
Endpoint URL address:
/file_requests/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-file-requests-id/.
The resource includes the fields from the FileRequest template.
- action
Field components:
-
Uses template:
FileRequest. - Contains the following components: copy.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/files/{{=parameters.file_id}}/versions.The action has the following user-defined parameters:
- file_id: Required. The unique identifier that represents a file.
Documentation: https://developer.box.com/reference/get-files-id-versions/.
- [Read single] action
-
Endpoint URL address:
/files/{{=parameters.file_id}}/versions/{{=parameters.file_version_id}}.The action has the following user-defined parameters:
- file_id: Required. The unique identifier that represents a file.
- file_version_id: Required. The ID of the file version
Documentation: https://developer.box.com/reference/get-files-id-versions-id/.
- [Create] action
-
Endpoint URL address:
/files/{{=item.file_id}}/versions/current.Documentation: https://developer.box.com/reference/post-files-id-versions-current/.
- [Update] action
-
Endpoint URL address:
/files/{{=item.file_id}}/versions/{{=item.id}}.Documentation: https://developer.box.com/reference/put-files-id-versions-id/.
- [Delete] action
-
Endpoint URL address:
/files/{{=item.file_id}}/versions/{{=item.id}}.The action has the following user-defined parameters:
- if-match: Ensures this item hasn't recently changed before making changes.
The following request parameters will be automatically processed:
-
if-match:
{{=parameters.get('if-match')}}
Documentation: https://developer.box.com/reference/delete-files-id-versions-id/.
The resource includes the fields from the FileVersion--Full template.
- trashed_at
Template: ShortText.
- file_id
Template: ShortText.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/enterprises/{{=parameters.enterprise_id}}/device_pinners.The action has the following user-defined parameters:
- enterprise_id: Required. The ID of the enterprise
- direction: The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.
Documentation: https://developer.box.com/reference/get-enterprises-id-device-pinners/.
- [Read single] action
-
Endpoint URL address:
/device_pinners/{{=parameters.device_pinner_id}}.The action has the following user-defined parameters:
- device_pinner_id: Required. The ID of the device pin
Documentation: https://developer.box.com/reference/get-device-pinners-id/.
- [Delete] action
-
Endpoint URL address:
/device_pinners/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-device-pinners-id/.
The resource includes the fields from the DevicePinner template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/email_aliases.The action has the following user-defined parameters:
- user_id: Required. The ID of the user.
Documentation: https://developer.box.com/reference/get-users-id-email-aliases/.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/email_aliases.Documentation: https://developer.box.com/reference/post-users-id-email-aliases/.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/email_aliases/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-users-id-email-aliases-id/.
The resource includes the fields from the EmailAlias template.
- user_id
Template: ShortText.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/metadata_templates/{{=parameters.template_id}}.The action has the following user-defined parameters:
- template_id: Required. The ID of the template
Documentation: https://developer.box.com/reference/get-metadata-templates-id/.
- [Read enterprise] action
-
Endpoint URL address:
/metadata_templates/enterprise.Documentation: https://developer.box.com/reference/get-metadata-templates-enterprise/.
- [Read global] action
-
Endpoint URL address:
/metadata_templates/global.Documentation: https://developer.box.com/reference/get-metadata-templates-global/.
- [Read instance] action
-
Endpoint URL address:
/metadata_templates.The action has the following user-defined parameters:
- metadata_instance_id: Required. The ID of an instance of the metadata template to find.
Documentation: https://developer.box.com/reference/get-metadata-templates/.
- [Read scope key] action
-
Endpoint URL address:
/metadata_templates/{{=parameters.scope}}/{{=parameters.template_key}}/schema.The action has the following user-defined parameters:
- scope: Required. The scope of the metadata template
- template_key: Required. The name of the metadata template
Documentation: https://developer.box.com/reference/get-metadata-templates-id-id-schema/.
- [Create] action
-
Endpoint URL address:
/metadata_templates/schema.Documentation: https://developer.box.com/reference/post-metadata-templates-schema/.
- [Update] action
-
Endpoint URL address:
/metadata_templates/{{=item.scope}}/{{=item.template_key}}/schema.Documentation: https://developer.box.com/reference/put-metadata-templates-id-id-schema/.
- [Delete] action
-
Endpoint URL address:
/metadata_templates/{{=item.scope}}/{{=item.template_key}}/schema.Documentation: https://developer.box.com/reference/delete-metadata-templates-id-id-schema/.
The resource includes the fields from the ObjectBaseT template.
- scope
Template: ShortText.
- templateKey
Template: ShortText.
- displayName
Template: ShortText.
- hidden
Data type: DT_BOOL
- copyInstanceOnItemCopy
Data type: DT_BOOL
- op
Template: ShortText.
- data
Template: ShortText.
- fieldKey
Template: ShortText.
- fieldKeys
Template: LongText. A composite field.
- enumOptionKey
Template: ShortText.
- enumOptionKeys
Template: LongText. A composite field.
- multiSelectOptionKey
Template: ShortText.
- multiSelectOptionKeys
Template: LongText. A composite field.
Based on resource template Base.
- [Read Event] action
-
Endpoint URL address:
/events.
The result is paginated.The action has the following user-defined parameters:
- stream_type: Defines the type of events that are returned.
- stream_position: The location in the event stream to start receiving events from.
- event_type: A comma-separated list of events to filter by.
- created_after: The lower bound date and time to return events for.
- created_before: The upper bound date and time to return events for.
The following request parameters will be automatically processed:
-
limit:
{{=parameters.batchSize}} -
stream_position:
{{=parameters.iterator}}
Documentation: https://developer.box.com/reference/get-events/.
The resource includes the fields from the Event template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/legal_hold_policy_assignments.The action has the following user-defined parameters:
- policy_id: Required. The ID of the legal hold policy
- assign_to_type: Filters the results by the type of item the policy was applied to.
- assign_to_id: Filters the results by the ID of item the policy was applied to.
Documentation: https://developer.box.com/reference/get-legal-hold-policy-assignments/.
- [Read single] action
-
Endpoint URL address:
/legal_hold_policy_assignments/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the legal hold policy assignment
Documentation: https://developer.box.com/reference/get-legal-hold-policy-assignments-id/.
- [Create] action
-
Endpoint URL address:
/legal_hold_policy_assignments.Documentation: https://developer.box.com/reference/post-legal-hold-policy-assignments/.
- [Delete] action
-
Endpoint URL address:
/legal_hold_policy_assignments/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-legal-hold-policy-assignments-id/.
The resource includes the fields from the ObjectBaseT template.
- policy_id
Template: ShortText.
- assign_to
Template: ObjectBaseT.
- current_file_versions
The value is gathered from
/legal_hold_policy_assignments/{{=item.id}}/files_on_holdaddress. The gathered value is processed with{{=response.entries}}expression. Field components:- An array.
-
Uses template:
FileVersionLegalHolds.
- previous_file_versions
The value is gathered from
/legal_hold_policy_assignments/{{=item.id}}/file_versions_on_holdaddress. The gathered value is processed with{{=response.entries}}expression. Field components:- An array.
-
Uses template:
FileVersionLegalHolds.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/file_version_retentions.The action has the following user-defined parameters:
- file_id: Filters results by files with this ID.
- file_version_id: Filters results by file versions with this ID.
- policy_id: Filters results by the retention policy with this ID.
- disposition_action: Filters results by the retention policy with this disposition action.
- disposition_before: Filters results by files that will have their disposition come into effect before this date.
- disposition_after: Filters results by files that will have their disposition come into effect after this date.
Documentation: https://developer.box.com/reference/get-file-version-retentions/.
- [Read single] action
-
Endpoint URL address:
/file_version_retentions/{{=parameters.file_version_retention_id}}.The action has the following user-defined parameters:
- file_version_retention_id: Required. The ID of the file version retention
Documentation: https://developer.box.com/reference/get-file-version-retentions-id/.
The resource includes the fields from the FileVersionRetention template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/folder_locks.The action has the following user-defined parameters:
- folder_id: Required. The unique identifier that represent a folder.
Documentation: https://developer.box.com/reference/get-folder-locks/.
- [Create] action
-
Endpoint URL address:
/folder_locks.Documentation: https://developer.box.com/reference/post-folder-locks/.
- [Delete] action
-
Endpoint URL address:
/folder_locks/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-folder-locks-id/.
The resource includes the fields from the FolderLock template.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/group_memberships/{{=parameters.group_membership_id}}.The action has the following user-defined parameters:
- group_membership_id: Required. The ID of the group membership.
Documentation: https://developer.box.com/reference/get-group-memberships-id/.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/memberships.The action has the following user-defined parameters:
- user_id: Required. The ID of the user.
Documentation: https://developer.box.com/reference/get-users-id-memberships/.
- [Read group] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/memberships.The action has the following user-defined parameters:
- group_id: Required. The ID of the group.
Documentation: https://developer.box.com/reference/get-groups-id-memberships/.
- [Create] action
-
Endpoint URL address:
/group_memberships.Documentation: Creates a group membership. Only users with admin-level permissions will be able to use this API..
- [Update] action
-
Endpoint URL address:
/group_memberships/{{=item.id}}.Documentation: https://developer.box.com/reference/post-group-memberships/.
- [Delete] action
-
Endpoint URL address:
/group_memberships/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-group-memberships-id/.
The resource includes the fields from the GroupMembership template.
- configurable_permissions
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.The action has the following user-defined parameters:
- filter_term: Limits the results to only groups whose `name` starts with the search term.
Documentation: https://developer.box.com/reference/get-groups/.
- [Read single] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}.The action has the following user-defined parameters:
- group_id: Required. The ID of the group.
Documentation: https://developer.box.com/reference/get-groups-id/.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://developer.box.com/reference/post-groups/.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developer.box.com/reference/put-groups-id/.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-groups-id/.
The resource includes the fields from the Group--Mini template.
- provenance
Template: ShortText.
- external_sync_identifier
Template: ShortText.
- description
Template: ShortText.
- invitability_level
Template: ShortText.
- member_viewability_level
Template: ShortText.
- collaborations
The gathered value is processed with
{{=connection.resourceManager['Collaboration'].getData({ endpoint: 'group', parameters: ['group_id=' + item.id]})}}expression. Field components:- An array.
-
Uses template:
Collaboration.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/invites/{{=parameters.invite_id}}.The action has the following user-defined parameters:
- invite_id: Required. The ID of an invite.
Documentation: https://developer.box.com/reference/get-invites-id/.
- [Create] action
-
Endpoint URL address:
/invites.Documentation: https://developer.box.com/reference/post-invites/.
The resource includes the fields from the Invite template.
- enterprise
Field components:
-
Uses template:
ShortText. - Contains the following components: id.
-
Uses template:
- actionable_by
Field components:
-
Uses template:
ShortText. - Contains the following components: login.
-
Uses template:
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/legal_hold_policies.The action has the following user-defined parameters:
- policy_name: Limits results to policies for which the names start with this search term. This is a case-insensitive prefix.
Documentation: https://developer.box.com/reference/get-legal-hold-policies/.
- [Read single] action
-
Endpoint URL address:
/legal_hold_policies/{{=parameters.legal_hold_policy_id}}.The action has the following user-defined parameters:
- legal_hold_policy_id: Required. The ID of the legal hold policy
Documentation: https://developer.box.com/reference/get-legal-hold-policies-id/.
- [Create] action
-
Endpoint URL address:
/legal_hold_policies.Documentation: https://developer.box.com/reference/post-legal-hold-policies/.
- [Update] action
-
Endpoint URL address:
/legal_hold_policies/{{=item.id}}.Documentation: https://developer.box.com/reference/put-legal-hold-policies-id/.
- [Delete] action
-
Endpoint URL address:
/legal_hold_policies/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-legal-hold-policies-id/.
The resource includes the fields from the LegalHoldPolicy template.
- is_ongoing
Data type: DT_BOOL
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/users.The action has the following user-defined parameters:
- filter_term: Limits the results to only users who's `name` or `login` start with the search term.
- user_type: Limits the results to the kind of user specified.
- external_app_user_id: Limits the results to app users with the given `external_app_user_id` value.
Documentation: https://developer.box.com/reference/get-users/.
- [Read single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}.The action has the following user-defined parameters:
- user_id: Required. The ID of the user.
Documentation: https://developer.box.com/reference/get-users-id/.
- [Read current] action
-
Endpoint URL address:
/users/me.Documentation: https://developer.box.com/reference/get-users-me/.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://developer.box.com/reference/post-users/.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://developer.box.com/reference/put-users-id/.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.id}}.The action has the following user-defined parameters:
- notify: Whether the user will receive email notification of the deletion
- force: Whether the user should be deleted even if this user still own files
Documentation: https://developer.box.com/reference/delete-users-id/.
The resource includes the fields from the User--Full template.
- notify
Data type: DT_BOOL
- is_password_reset_required
Data type: DT_BOOL
- avatar
Data type: DT_IMAGE The value is gathered from
/users/{{=item.id}}/avataraddress. The value is sent to/users/{{=item.id}}/avataraddress.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/retention_policies.The action has the following user-defined parameters:
- policy_name: Filters results by a case sensitive prefix of the name of retention policies.
- policy_type: Filters results by the type of retention policy.
- created_by_user_id: Filters results by the ID of the user who created policy.
Documentation: https://developer.box.com/reference/get-retention-policies/.
- [Read single] action
-
Endpoint URL address:
/retention_policies/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the retention policy.
Documentation: https://developer.box.com/reference/get-retention-policies-id/.
- [Create] action
-
Endpoint URL address:
/retention_policies.Documentation: https://developer.box.com/reference/post-retention-policies/.
- [Update] action
-
Endpoint URL address:
/retention_policies/{{=item.id}}.Documentation: https://developer.box.com/reference/put-retention-policies-id/.
- [Delete] action
-
Endpoint URL address:
/retention_policies/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-retention-policies-id/.
The resource includes the fields from the RetentionPolicy--Mini template.
- are_owners_notified
Template: ShortText.
- assignment_counts
Field components:
- Contains the following components: enterprise, folder, metadata_template.
- can_owner_extend_retention
Data type: DT_BOOL
- created_at
Template: DateTime.
- created_by
Template: User--Mini.
- custom_notification_recipients
Field components:
- An array.
-
Uses template:
User--Mini.
- description
Template: ShortText.
- modified_at
Template: DateTime.
- policy_type
Template: ShortText.
- retention_type
Template: ShortText.
- status
Template: ShortText.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/shield_information_barrier_reports.The action has the following user-defined parameters:
- shield_information_barrier_id: Required. The ID of the shield information barrier.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-reports/.
- [Read single] action
-
Endpoint URL address:
/shield_information_barrier_reports/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the shield information barrier Report.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-reports-id/.
- [Create] action
-
Endpoint URL address:
/shield_information_barrier_reports.Documentation: https://developer.box.com/reference/post-shield-information-barrier-reports/.
The resource includes the fields from the ShieldInformationBarrierReport template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/shield_information_barrier_segment_members.The action has the following user-defined parameters:
- shield_information_barrier_segment_id: Required. The ID of the shield information barrier segment.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-segment-members/.
- [Read single] action
-
Endpoint URL address:
/shield_information_barrier_segment_members/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the shield information barrier segment Member.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-segment-members-id/.
- [Create] action
-
Endpoint URL address:
/shield_information_barrier_segment_members.Documentation: https://developer.box.com/reference/post-shield-information-barrier-segment-members/.
- [Delete] action
-
Endpoint URL address:
/shield_information_barrier_segment_members/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-shield-information-barrier-segment-members-id/.
The resource includes the fields from the ShieldInformationBarrierSegmentMember template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/shield_information_barrier_segment_restrictions.The action has the following user-defined parameters:
- shield_information_barrier_segment_id: Required. The ID of the shield information barrier segment.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions/.
- [Read single] action
-
Endpoint URL address:
/shield_information_barrier_segment_restrictions/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the shield information barrier segment Restriction.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions-id/.
- [Create] action
-
Endpoint URL address:
/shield_information_barrier_segment_restrictions.Documentation: https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions/.
- [Delete] action
-
Endpoint URL address:
/shield_information_barrier_segment_restrictions/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-shield-information-barrier-segment-restrictions-id/.
The resource includes the fields from the ShieldInformationBarrierSegmentRestriction template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/shield_information_barrier_segments.The action has the following user-defined parameters:
- shield_information_barrier_id: Required. The ID of the shield information barrier.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-segments/.
- [Read single] action
-
Endpoint URL address:
/shield_information_barrier_segments/{{=parameters.shield_information_barrier_segment_id}}.The action has the following user-defined parameters:
- shield_information_barrier_segment_id: Required. The ID of the shield information barrier segment.
Documentation: https://developer.box.com/reference/get-shield-information-barrier-segments-id/.
- [Create] action
-
Endpoint URL address:
/shield_information_barrier_segments.Documentation: https://developer.box.com/reference/post-shield-information-barrier-segments/.
- [Update] action
-
Endpoint URL address:
/shield_information_barrier_segments/{{=item.id}}.Documentation: https://developer.box.com/reference/put-shield-information-barrier-segments-id/.
- [Delete] action
-
Endpoint URL address:
/shield_information_barrier_segments/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-shield-information-barrier-segments-id/.
The resource includes the fields from the ShieldInformationBarrierSegment template.
Based on resource template Pagination.
- [Read Workflow] action
-
Endpoint URL address:
/workflows.The action has the following user-defined parameters:
- folder_id: Required. The unique identifier that represent a folder.
- trigger_type: Type of trigger to search for.
Documentation: https://developer.box.com/reference/get-workflows/.
- [Create] action
-
Endpoint URL address:
/workflows/{{=parameters.workflow_id}}/start.The action has the following user-defined parameters:
- workflow_id: Required. The ID of the workflow.
Documentation: https://developer.box.com/reference/post-workflows-id-start/.
The resource includes the fields from the ObjectBaseT template.
- name
Template: ShortText.
- description
Template: ShortText.
- is_enabled
Data type: DT_BOOL
- flows
Field components:
- An array.
-
Uses template:
ObjectBaseT. - Contains the following components: trigger, outcomes, created_at, created_by.
- flow
Template: ObjectBaseT.
- files
Field components:
- An array.
-
Uses template:
ObjectBaseT.
- folder
Template: ObjectBaseT.
- outcomes
Field components:
- An array.
-
Uses template:
ObjectBaseT.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/storage_policies.Documentation: https://developer.box.com/reference/get-storage-policies/.
- [Read single] action
-
Endpoint URL address:
/storage_policies/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the storage policy.
Documentation: https://developer.box.com/reference/get-storage-policies-id/.
The resource includes the fields from the StoragePolicy template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/storage_policy_assignments.The action has the following user-defined parameters:
- resolved_for_type: Required. The target type to return assignments for
- resolved_for_id: Required. The ID of the user or enterprise to return assignments for
Documentation: https://developer.box.com/reference/get-storage-policy-assignments/.
- [Read single] action
-
Endpoint URL address:
/storage_policy_assignments/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the storage policy assignment.
Documentation: https://developer.box.com/reference/get-storage-policy-assignments-id/.
- [Create] action
-
Endpoint URL address:
/storage_policy_assignments.Documentation: https://developer.box.com/reference/post-storage-policy-assignments/.
- [Update] action
-
Endpoint URL address:
/storage_policy_assignments/{{=parameters.storage_policy_assignment_id}}.The action has the following user-defined parameters:
- storage_policy_assignment_id: Required. The ID of the storage policy assignment.
Documentation: https://developer.box.com/reference/put-storage-policy-assignments-id/.
- [Delete] action
-
Endpoint URL address:
/storage_policy_assignments/{{=parameters.storage_policy_assignment_id}}.The action has the following user-defined parameters:
- storage_policy_assignment_id: Required. The ID of the storage policy assignment.
Documentation: https://developer.box.com/reference/delete-storage-policy-assignments-id/.
- assigned_to
Template: ObjectBaseT.
- storage_policy
Template: ObjectBaseT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/files/{{=parameters.file_id}}/tasks.The action has the following user-defined parameters:
- file_id: Required. The unique identifier that represents a file.
Documentation: https://developer.box.com/reference/get-files-id-tasks/.
- [Read single] action
-
Endpoint URL address:
/tasks/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. The ID of the task.
Documentation: https://developer.box.com/reference/get-tasks-id/.
- [Create] action
-
Endpoint URL address:
/tasks.Documentation: https://developer.box.com/reference/post-tasks/.
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developer.box.com/reference/put-tasks-id/.
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-tasks-id/.
The resource includes the fields from the Task template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/terms_of_services.The action has the following user-defined parameters:
- tos_type: Limits the results to the terms of service of the given type.
Documentation: https://developer.box.com/reference/get-terms-of-services/.
- [Read single] action
-
Endpoint URL address:
/terms_of_services/{{=parameters.terms_of_service_id}}.The action has the following user-defined parameters:
- terms_of_service_id: Required. The ID of the terms of service.
Documentation: https://developer.box.com/reference/get-terms-of-services-id/.
- [Create] action
-
Endpoint URL address:
/terms_of_services.Documentation: https://developer.box.com/reference/post-terms-of-services/.
- [Update] action
-
Endpoint URL address:
/terms_of_services/{{=item.id}}.Documentation: https://developer.box.com/reference/put-terms-of-services-id/.
The resource includes the fields from the TermsOfService template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/terms_of_service_user_statuses.The action has the following user-defined parameters:
- tos_id: Required. The ID of the terms of service.
- user_id: Limits results to the given user ID.
Documentation: https://developer.box.com/reference/get-terms-of-service-user-statuses/.
- [Create] action
-
Endpoint URL address:
/terms_of_service_user_statuses.Documentation: https://developer.box.com/reference/post-terms-of-service-user-statuses/.
- [Update] action
-
Endpoint URL address:
/terms_of_service_user_statuses/{{=item.id}}.Documentation: https://developer.box.com/reference/put-terms-of-service-user-statuses-id/.
The resource includes the fields from the TermsOfServiceUserStatus template.
Based on resource template Pagination.
- [Read] action
-
Endpoint URL address:
/webhooks.Documentation: https://developer.box.com/reference/get-webhooks/.
- [Read single] action
-
Endpoint URL address:
/webhooks/{{=parameters.webhook_id}}.The action has the following user-defined parameters:
- webhook_id: Required. The ID of the webhook.
Documentation: https://developer.box.com/reference/get-webhooks-id/.
- [Create] action
-
Endpoint URL address:
/webhooks.Documentation: https://developer.box.com/reference/post-webhooks/.
- [Update] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developer.box.com/reference/put-webhooks-id/.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-webhooks-id/.
The resource includes the fields from the Webhook template.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/web_links/{{=parameters.web_link_id}}.The action has the following user-defined parameters:
- web_link_id: Required. The ID of the web link.
- boxapi: The URL, and optional password, for the shared link of this item.
The following request parameters will be automatically processed:
-
boxapi:
{{=parameters.get('boxapi')}}
Documentation: https://developer.box.com/reference/get-web-links-id/.
- [Read shared] action
-
Endpoint URL address:
/shared_items.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- boxapi: Required. A header containing the shared link and optional password for the shared link.
- if-none-match: Ensures an item is only returned if it has changed.
The following request parameters will be automatically processed:
-
if-none-match:
{{=parameters.get('if-none-match')}} -
boxapi:
{{=parameters.get('boxapi')}}
Documentation: https://developer.box.com/reference/get-shared-items--web-links/.
- [Create] action
-
Endpoint URL address:
/web_links.Documentation: https://developer.box.com/reference/post-web-links/.
- [Update] action
-
Endpoint URL address:
/web_links/{{=item.id}}.Documentation: https://developer.box.com/reference/put-web-links-id/.
- [Delete] action
-
Endpoint URL address:
/web_links/{{=item.id}}.Documentation: https://developer.box.com/reference/delete-web-links-id/.
The resource includes the fields from the WebLink template.
- action
Field components:
-
Uses template:
SharedLinkT. - Contains the following components: set_shared_link.
-
Uses template:
- [Read] action
-
The result is extracted from:{{=response.entries}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
limit:
{{=parameters.batchSize}} -
fields:
{{=_.filter(parameters.fields, function(field) { return field.indexOf('.') == -1; }).join()}}
-
_includeUserParameters:
- [Read single] action
-
The result is extracted from:{{=[response]}}.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
usemarker:
true -
marker:
{{=parameters.iterator}}
-
usemarker:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- ObjectBaseT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, type.
-
Uses template:
- ObjectT
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: name.
-
Uses template:
- OrderT
Field components:
-
Uses template:
ShortText. - Contains the following components: by, direction.
-
Uses template:
- Metadata--Base
Field components:
-
Uses template:
ShortText. - Contains the following components: $parent, $template, $scope, $version.
-
Uses template:
- User--Mini
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: name, login.
-
Uses template:
- Classification
Template: Metadata--Base. Field components:
-
Uses template:
ShortText. - Contains the following components: Box__Security__Classification__Key, $type, $typeVersion, $canEdit.
-
Uses template:
- User--Collaborations
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: name, login.
-
Uses template:
- Collaboration
Template: ObjectBaseT. Field components:
-
Uses template:
LongText. - Contains the following components: item, accessible_by, invite_email, role, expires_at, status, acknowledged_at, created_by, created_at, modified_at, acceptance_requirements_status.
-
Uses template:
- CollaborationAllowlistEntry
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: domain, direction, enterprise, created_at.
-
Uses template:
- CollaborationAllowlistExemptTarget
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectT. - Contains the following components: enterprise, user, created_at, modified_at.
-
Uses template:
- Collection
Template: ObjectT. Field components:
-
Uses template:
ShortText. - Contains the following components: collection_type.
-
Uses template:
- Comment
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: is_reply_comment, message, created_by, created_at, modified_at, item.
-
Uses template:
- DevicePinner
Template: ObjectBaseT. Field components:
-
Uses template:
User--Mini. - Contains the following components: owned_by, product_name.
-
Uses template:
- EmailAlias
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: email, is_confirmed.
-
Uses template:
- Event
Field components:
-
Uses template:
ShortText. - Contains the following components: type, created_at, recorded_at, event_id, created_by, event_type, session_id, source, additional_details.
-
Uses template:
- SharedLinkT
Field components:
-
Uses template:
ShortText. - Contains the following components: access, download_count, download_url, effective_access, effective_permission, is_password_enabled, permissions, preview_count, unshared_at, url, vanity_url, vanity_name.
-
Uses template:
- File--Base
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: etag.
-
Uses template:
- File--Mini
Template: File--Base. Field components:
-
Uses template:
LongText. - Contains the following components: sequence_id, name, sha1, file_version.
-
Uses template:
- File
Template: File--Mini. Field components:
-
Uses template:
ShortText. - Contains the following components: description, size, path_collection, created_at, modified_at, trashed_at, purged_at, content_created_at, content_modified_at, created_by, modified_by, owned_by, shared_link, parent, item_status.
-
Uses template:
- File--Full
Template: File. Field components:
-
Uses template:
ShortText. - Contains the following components: version_number, comment_count, permissions, tags, lock, extension, is_package, expiring_embed_link, watermark_info, is_accessible_via_shared_link, allowed_invitee_roles, is_externally_owned, has_collaborations, metadata, expires_at, representations, classification, uploader_display_name, disposition_at, shared_link_permission_options.
-
Uses template:
- FileRequest
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: title, description, status, is_email_required, is_description_required, expires_at, folder, url, etag, created_by, created_at, updated_by, updated_at.
-
Uses template:
- Files
Field components:
- Contains the following components: total_count, entries.
- FileVersion--Mini
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: sha1.
-
Uses template:
- FileVersion
Template: FileVersion--Mini. Field components:
-
Uses template:
ShortText. - Contains the following components: name, size, created_at, modified_at, modified_by, trashed_at, trashed_by, restored_at, restored_by, purged_at, uploader_display_name.
-
Uses template:
- FileVersion--Full
Template: FileVersion. Field components:
-
Uses template:
ShortText. - Contains the following components: version_number.
-
Uses template:
- FileVersionLegalHold
Template: ObjectBaseT. Field components:
-
Uses template:
FileVersion--Mini. - Contains the following components: file_version, file, legal_hold_policy_assignments, deleted_at.
-
Uses template:
- FileVersionLegalHolds
Field components:
- Contains the following components: entries.
- FileVersionRetention
Template: ObjectBaseT. Field components:
-
Uses template:
FileVersion--Mini. - Contains the following components: file_version, file, applied_at, disposition_at, winning_retention_policy.
-
Uses template:
- Folder--Base
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: etag.
-
Uses template:
- Folder--Mini
Template: Folder--Base. Field components:
-
Uses template:
LongText. - Contains the following components: sequence_id, name.
-
Uses template:
- Folder
Template: Folder--Mini. Field components:
-
Uses template:
DateTime. - Contains the following components: created_at, modified_at, description, size, path_collection, created_by, modified_by, trashed_at, purged_at, content_created_at, content_modified_at, owned_by, shared_link, folder_upload_email, parent, item_status, item_collection.
-
Uses template:
- Folder--Full
Template: Folder. Field components:
-
Uses template:
LongText. - Contains the following components: sync_state, has_collaborations, permissions, tags, can_non_owners_invite, is_externally_owned, metadata, is_collaboration_restricted_to_enterprise, allowed_shared_link_access_levels, allowed_invitee_roles, watermark_info, is_accessible_via_shared_link, can_non_owners_view_collaborators, classification.
-
Uses template:
- FolderLock
Template: ObjectBaseT. Field components:
-
Uses template:
Folder--Mini. - Contains the following components: folder, created_by, created_at, locked_operations, lock_type.
-
Uses template:
- Group--Mini
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: name, group_type.
-
Uses template:
- GroupMembership
Template: ObjectBaseT. Field components:
-
Uses template:
User--Mini. - Contains the following components: user, group, role, created_at, modified_at.
-
Uses template:
- Invite
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectT. - Contains the following components: invited_to, actionable_by, invited_by, status, created_at, modified_at.
-
Uses template:
- Items
Field components:
-
Uses template:
LongText. - Contains the following components: total_count, order, entries.
-
Uses template:
- LegalHoldPolicy
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: policy_name, description, status, assignment_counts, created_by, created_at, modified_at, deleted_at, filter_started_at, filter_ended_at, release_notes.
-
Uses template:
- LegalHoldPolicyAssignment
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: legal_hold_policy, assigned_to, assigned_by, assigned_at, deleted_at.
-
Uses template:
- Metadata
Template: Metadata--Base.
- RecentItem
Field components:
-
Uses template:
ShortText. - Contains the following components: type, item, interaction_type, interacted_at, interaction_shared_link.
-
Uses template:
- RetentionPolicy--Mini
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: policy_name, retention_length, disposition_action.
-
Uses template:
- ShieldInformationBarrier
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: enterprise, status, created_at, created_by, updated_at, updated_by, enabled_at, enabled_by.
-
Uses template:
- ShieldInformationBarrierReference
Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: shield_information_barrier.
-
Uses template:
- ShieldInformationBarrierReport
Template: ObjectBaseT. Field components:
-
Uses template:
ShieldInformationBarrierReference. - Contains the following components: shield_information_barrier, status, details, created_at, created_by, updated_at.
-
Uses template:
- ShieldInformationBarrierReportDetails
Field components:
- Contains the following components: details.
- ShieldInformationBarrierSegment
Template: ObjectT. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: shield_information_barrier, description, created_at, created_by, updated_at, updated_by.
-
Uses template:
- ShieldInformationBarrierSegmentMember--Mini
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: user.
-
Uses template:
- ShieldInformationBarrierSegmentMember
Template: ShieldInformationBarrierSegmentMember--Mini. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: shield_information_barrier, shield_information_barrier_segment, created_at, created_by, updated_at, updated_by.
-
Uses template:
- ShieldInformationBarrierSegmentRestriction--Mini
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: shield_information_barrier_segment, restricted_segment.
-
Uses template:
- ShieldInformationBarrierSegmentRestriction
Template: ShieldInformationBarrierSegmentRestriction--Mini. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: shield_information_barrier, created_at, created_by, updated_at, updated_by.
-
Uses template:
- SignRequest--Base
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: is_document_preparation_needed, redirect_url, declined_redirect_url, are_text_signatures_enabled, email_subject, email_message, are_reminders_enabled, parent_folder, name, prefill_tags, days_valid, external_id, is_phone_verification_required_to_view.
-
Uses template:
- SignRequest
Template: SignRequest--Base. Field components:
-
Uses template:
ShortText. - Contains the following components: signers, signature_color, prepare_url, signing_log, status, sign_files, auto_expire_at, source_files.
-
Uses template:
- SignRequestCreateSigner
Field components:
-
Uses template:
ShortText. - Contains the following components: email, role, is_in_person, order, embed_url_external_user_id, redirect_url, declined_redirect_url, login_required, verification_phone_number, password.
-
Uses template:
- SignRequestPrefillTag
Field components:
-
Uses template:
ShortText. - Contains the following components: document_tag_id, text_value, checkbox_value, date_value.
-
Uses template:
- SignRequestSigner
Template: SignRequestCreateSigner. Field components:
-
Uses template:
ShortText. - Contains the following components: has_viewed_document, signer_decision, inputs, embed_url.
-
Uses template:
- SignRequestSignerInput
Template: SignRequestPrefillTag. Field components:
-
Uses template:
ShortText. - Contains the following components: type, content_type, page_index.
-
Uses template:
- StoragePolicy
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: name.
-
Uses template:
- Task
Template: ObjectBaseT. Field components:
-
Uses template:
File--Mini. - Contains the following components: item, due_at, action, message, task_assignment_collection, is_completed, created_by, created_at, completion_rule.
-
Uses template:
- TaskAssignment
Template: ObjectBaseT. Field components:
-
Uses template:
File--Mini. - Contains the following components: item, assigned_to, message, completed_at, assigned_at, reminded_at, resolution_state, assigned_by.
-
Uses template:
- TermsOfService
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: status, enterprise, tos_type, text, created_at, modified_at.
-
Uses template:
- TermsOfServiceUserStatus
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: tos, user, is_accepted, created_at, modified_at.
-
Uses template:
- TrackingCode
Field components:
-
Uses template:
ShortText. - Contains the following components: type, name, value.
-
Uses template:
- TrashFile
Template: ObjectT. Field components:
-
Uses template:
ShortText. - Contains the following components: etag, sequence_id, sha1, file_version, description, size, path_collection, created_at, modified_at, trashed_at, purged_at, content_created_at, content_modified_at, created_by, modified_by, owned_by, shared_link, parent, item_status.
-
Uses template:
- TrashFileRestored
Template: ObjectT. Field components:
-
Uses template:
ShortText. - Contains the following components: etag, sequence_id, sha1, file_version, description, size, path_collection, created_at, modified_at, trashed_at, purged_at, content_created_at, content_modified_at, created_by, modified_by, owned_by, shared_link, parent, item_status.
-
Uses template:
- UploadPart
Template: UploadPart--Mini. Field components:
-
Uses template:
ShortText. - Contains the following components: sha1.
-
Uses template:
- UploadPart--Mini
Field components:
-
Uses template:
ShortText. - Contains the following components: part_id, size.
-
Uses template:
- UploadParts
Field components:
- Contains the following components: total_count, order, entries.
- UploadSession
Template: ObjectBaseT. Field components:
-
Uses template:
DateTime. - Contains the following components: session_expires_at, part_size, total_parts, num_parts_processed, session_endpoints.
-
Uses template:
- User
Template: User--Mini. Field components:
-
Uses template:
DateTime. - Contains the following components: created_at, modified_at, language, timezone, space_amount, space_used, max_upload_size, status, job_title, phone, address, avatar_url, notification_email.
-
Uses template:
- User--Full
Template: User. Field components:
-
Uses template:
ShortText. - Contains the following components: role, tracking_codes, can_see_managed_users, is_sync_enabled, is_external_collab_restricted, is_exempt_from_device_limits, is_exempt_from_login_verification, enterprise, my_tags, hostname, is_platform_access_only, external_app_user_id.
-
Uses template:
- Webhook--Mini
Template: ObjectBaseT. Field components:
-
Uses template:
ObjectBaseT. - Contains the following components: target.
-
Uses template:
- Webhook
Template: Webhook--Mini. Field components:
-
Uses template:
User--Mini. - Contains the following components: created_by, created_at, address, triggers.
-
Uses template:
- WebLink--Base
Template: ObjectBaseT. Field components:
-
Uses template:
ShortText. - Contains the following components: etag.
-
Uses template:
- WebLink--Mini
Template: WebLink--Base. Field components:
-
Uses template:
ShortText. - Contains the following components: url, sequence_id, name.
-
Uses template:
- WebLink
Template: WebLink--Mini. Field components:
-
Uses template:
Folder--Mini. - Contains the following components: parent, description, path_collection, created_at, modified_at, trashed_at, purged_at, created_by, modified_by, owned_by, shared_link, item_status.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.