2020 - Box Dev Docs

Impactful changesAPI

Blank OAuth 2 redirect URI change

On September 28th, 2020 we announced upcoming changes to our security requirements for OAuth 2 app redirect URIs. As of today, applications that use a blank redirect URI will no longer be permitted, and will begin to produce an error stating redirect_uri missing when attempting to redirect the user, stating that there is a mismatched URI.Impacted applications will have received multiple emails to the developer email address associated with the application and account, and are part of a small subset of applications that were grandfathered in to allow the functionality to persist.New applications, or any OAuth 2 applications that have a redirect URI specified are not impacted.

How to update your OAuth 2 app redirect URI

If your OAuth 2 application has started to produce an error during the redirect phase, you may be impacted by this change. To update your application(s), use the following steps:

Go to the Box developer console as the user who owns the application(s).
From the top navigation, click on Configuration.
Scroll down to the OAuth 2.0 Redirect URI section.
For any application where this URI is blank, add the URI that is being used in the application code when redirecting the user back to your application from the Box auth step, as is described in this guide.

API

New type field in search API responses

A new field, type, has been introduced in the search result response object for returned shared link items.This response object format is only returned when making calls to the content search endpoint with the include_recent_shared_links query parameter set to true.There is no impact to existing applications that are currently consuming this response object.

Updates

Prior to this release, the return object for shared link search results included two objects:

accessible_via_shared_link: The shared link which the item is accessible from.
item: The file, folder, or web link that matched the search query.

{
  "accessible_via_shared_link": "https://www.box.com/s/vfejh7y01sb263wjtgfe",
  "item": {
    ...
  }
}

This update introduces the new type field, which is a string that will always be set to search_result.

{
  "type": "search_result",
  "accessible_via_shared_link": "https://www.box.com/s/vfejh7y01sb263wjtgfe",
  "item": {
    ...
  }
}

For complete format information see the shared link search result response object.

New featuresCLI

Box CLI v2.8.0 released

Warning

Due to the changes in (#217), additional details about Box Items may now be returned for some commands.

New Features and Enhancements

Output contents of array for bulk commands (#217)

Bug Fixes

Fix bug with setting proxy settings (#218)

New featuresJavaSDKs

Box Java SDK v2.52.0 released

New Features and Enhancements

Add folder lock functionality (#856)
Add support for search parameter to get shared link items (#855)

Bug Fixes

Fix bug with updating tracking codes (#857)

New featuresAPI

Announcing Client Credentials Grant authentication

A new method for authenticating your JWT applications is now released. This new method, Client Credentials Grant, does not impact existing applications but offers an easier way to authenticate for new apps. Prior to today, we required a public/private key pair and assertion to verify an application’s identity and retrieve an Access Token. Now, you can request a token using only your client ID and client secret.

curl --location --request POST ‘https://api.box.com/oauth2/token’ \
--header ‘Content-Type: application/x-www-form-urlencoded’ \
--data-urlencode ‘client_id=<client_id>’ \
--data-urlencode ‘client_secret=<client_secret>’ \
--data-urlencode ‘grant_type=client_credentials’ \
--data-urlencode ‘box_subject_type=enterprise’ \
--data-urlencode ‘box_subject_id=<enterprise_id>’

For further information, please visit our guide.

Updates

Added client credentials grant as an auth option for new applications
Added 2FA requirement to copy/view client secret
Added selected authentication method in the Enterprise Authorization request
Removed the ability to change authentication type

New featuresiOSSDKs

Box iOS SDK v4.2.0 released

Breaking Changes

New Features and Enhancements

Add error information for disconnected OAuth web sessions

Bug Fixes

Fix bug with creating collaboration
Fix bug with getting enterprise events

JavaSDKs

Box Java SDK v2.51.1 released

Bug Fixes

Fix for cross-enterprise collaborator calls to updateMetadata on files

New featuresUI Elements

Box Content Preview v2.57.0 released

New Features and Enhancements

Add react versions of core control components (#1282)
Add react versions of existing control icons (#1280)
Add react versions of fullscreen and zoom controls (#1283)
Add react versions of text viewer controls (#1284)
Add instrumentation for annotation creation (#1275)
Upgrade react and react-dom to ^16.9.0 (#1278)

Bug Fixes

Select newly created annotation (#1276)
Allow download of files via embedded links in Chrome (#1277)
Revert pdf.js to v2.2.228 due to font rendering issue (#1274)

API

Simplified App Creation Flow

A new, simplified app creation flow is now available in the Box Developer Console. The three types of applications are Custom Apps, Limited Access Apps, and Box Custom Skills.We added plain language to describe exactly when to select each app type and links to relevant documentation if you require additional information to help with your selection. The application type you select impacts which authentication methods are available.Most notably, is our new app type, Limited Access Apps. Select this app type if you’d like to leverage Box View or Box’s preview services within another application. This app type only provides access to app token authentication, which has restricted API capabilities. For full details, please visit our guide on selecting an app type.

New featuresCLI

Box CLI v2.7.0 released

New Features and Enhancements

Make commands collaborations:add, shared-links:update, shared-links:delete, users:search that were previously hidden, now available (#211)
Add filter_term parameter to groups:list (#210)

Bug Fixes

Fix bug with setting proxy settings (#213)

New featuresNodeSDKs

Box Node SDK v1.35.0 released

New Features and Enhancements

Add support for search parameter to get shared link items (#547)

New featuresJavaSDKs

Box Java SDK v2.51.0 released

New Features and Enhancements

Add support for copyInstanceOnItemCopy field for metadata templates (#850)
Add support for more fields in BoxCollaborator.Info (#843)

Bug Fixes

Update getAllGroupsByName() to use documented parameter (#851)

New featuresAPI

New Folder Lock APIs now available

A new collections of APIs have been released to allow developers to lock move and delete operations on folders. New API reference and guides have been made available to help create and manage you folder locks.To create a lock on a folder to prevent it from being moved or deleted, supply the ID of a folder to the folder_locks endpoint.

curl -i -X POST "https://api.box.com/2.0/folder_locks" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "folder": {
         "type": "folder",
         "id": "33552487093"
       }
     }'

Additional API endpoints are available to allow a developer to list all locks on a given folder, or to delete an existing folder lock with a folder lock ID.

Create a folder lock: Guide | API Reference
List all locks on a folder: Guide | API Reference
Delete a folder lock: Guide | API Reference

New featuresAPI

New Folder Lock APIs now available

A new collections of APIs have been released to permit the restriction of move and delete actions on folders. New API reference and guides have been made available to help create and manage you folder locks.To create a lock on a folder to prevent it from being moved or deleted, supply the ID of a folder to the POST /folder_locks/ endpoint.

curl -i -X POST "https://api.box.com/2.0/folder_locks" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "folder": {
         "type": "folder",
         "id": "33552487093"
       }
     }'

Additional API endpoints are available to allow a developer to list all locks on a given folder, or to remove an existing folder lock from a folder.

Create a folder lock: Guide | API Reference
List all locks on a folder: Guide | API Reference
Remove a folder lock: Guide | API Reference

API

Metadata Cascade Policies API leaves Beta

The Metadata Cascade Policies API is now generally available to all and no longer in Beta.Over the past years, we’ve made a lot of technical improvements to our metadata infrastructure and we’re happy to announce that we’ve now gotten to the moment where the Metadata Cascade Policies API is leaving Beta. This release does not involve any breaking changes and any existing application should not see any impact from this release.Since we initially launched, Metadata Cascade Policies has become over 10 times faster when applying metadata to new instances. Additionally, we’ve also made significant strides in reliability and observability to ensure a top-notch API experience, in line with the rest of our API suite.For more details about metadata, and metadata cascade policies, please visit the Metadata guides and our dedicated Metadata Cascade Policies reference documentation.

New featuresWindowsSDKs

Box Windows SDK v3.25.0 released

New Features and Enhancements

Add support for filtering when getting Groups (#703)
Add zip functionality (#700)
Deprecate one of the overloaded ExecuteMetadataQueryAsync() methods (#699)
Add support for copyInstanceOnItemCopy field for metadata templates (#698)

Bug Fixes

Fix bug with JWT Authentication automatic retry (#697)

www.nuget.org/packages/Box.V2/3.25.0 www.nuget.org/packages/Box.V2.Core/3.25.0

New featuresAPI

Search API adds support for Shared Links

The Search API now supports returning files, folders and web links that the user has recently accessed through a shared link.Shared items can be requested by calling the GET /search API with the new include_recent_shared_links query parameter set to true.

curl -i -X GET https://api.box.com/2.0/search?query=Contract&include_recent_shared_link=true

By default, the API won’t return any shared items if this query parameter is not provided or not set to true.

Change in response format

When include_recent_shared_links is set to true, the response has slightly changed to allow for the additional information to be returned. Rather than returning a direct list of files, folders, and web links the API now returns a list of objects containing an item and an accessible_via_shared_link property.

With shared link results
Without

{
  "entries": [
    {
      "item": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf",
        ...
      },
      "accessible_via_shared_link": "https://www.box.com/s/vspke7y05sb214wjokpk"
    }
    ...
  ],
  "limit": 1000,
  "offset": 2000,
  "total_count": 5000
}

{
  "entries": [
    {
      "id": 12345,
      "etag": 1,
      "type": "file",
      "sequence_id": 3,
      "name": "Contract.pdf",
      ...
    },
    ...
  ],
  "limit": 1000,
  "offset": 2000,
  "total_count": 5000
}

This change in response format should not impact any existing applications as it only applies to any API call made with the new query parameter.

NodeSDKs

Box Node SDK v1.34.3 released

Bug Fixes

Upgrade ajv dependency (#545)

New featuresAPI

New File Request APIs available

A new collection of APIs are now available that allows developers to create and update File Requests. We’ve updated the reference documentation and added new guides to help you manage your file requests.To create a copy of an existing file request, all you need is the unique ID of an existing file request, and the ID of the folder to apply the new request to.

curl -i -X POST "https://api.box.com/2.0/file_requests/42037322/copy" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "folder": {
         "id": "2233212"
       }
     }'

Additional APIs are available that allow a developer to get more details about a file request, update a file request, and delete a file request. For more details, please check out the developer documentation.

Create a template file request: Guide
Create a copy of a file request: Guide | API Reference
Get information about a file request: Guide | API Reference
Update a file request’s configuration: Guide | API Reference
Delete a file request: Guide | API Reference

PythonSDKs

Box Python SDK v2.10.0 released

New Features and Enhancements

Add support for copyInstanceOnItemCopy field for metadata templates (#546)
Allow creating tasks with the action and completion_rule parameters (#544)
Add Zip functionality (#539)

Bug Fixes

Fix bug with updating a collaboration role to owner (#536)
Allow ints to be passed in as item IDs (#530)

Impactful changesAPI

Change to OAuth 2 app redirect URI requirements

On October 29th, 2020, Box will begin employing stricter requirements for redirect URIs used within new and existing OAuth 2-based Box integrations that may affect your application.Existing application owners that currently use a blank redirect URI in their application configuration, as described here, will need to update the redirect URI to match the redirect used within the code redirect step, described here.On October 29th, 2020, applications that are still configured with a blank URI will begin returning an error when the user is redirected back to your application if URI adjustments aren’t made.All impacted application owners and collaborators have been notified via the email address associated with their developer account.

How to validate and make the change

To validate your redirect URI and update your application(s) if they are affected, take the following steps:

Go to the Box developer console as the user who owns the application(s).
For each Custom App using OAuth 2 (client-side authentication) click on the application to open it.
From the left navigation, click on Configuration.
Scroll down to the OAuth 2.0 Redirect URI section.
For any application where this URI is blank, add the URI that is being used in the application code when redirecting the user back to your application from the Box auth step, as is described in this guide.

New featuresAPI

Search API adds support for Shared Links

curl -i -X GET https://api.box.com/2.0/search?query=Contract&include_recent_shared_link=true

By default, the API won’t return any shared items if this query parameter is not provided or not set to true.

Change in response format

With shared link results
Without

{
  "entries": [
    {
      "item": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf",
        ...
      },
      "accessible_via_shared_link": "https://www.box.com/s/vspke7y05sb214wjokpk"
    }
    ...
  ],
  "limit": 1000,
  "offset": 2000,
  "total_count": 5000
}

{
  "entries": [
    {
      "id": 12345,
      "etag": 1,
      "type": "file",
      "sequence_id": 3,
      "name": "Contract.pdf",
      ...
    },
    ...
  ],
  "limit": 1000,
  "offset": 2000,
  "total_count": 5000
}

This change in response format should not impact any existing applications as it only applies to any API call made with the new query parameter.

New featuresAPI

Group API adds new filter and permissions

The GET /groups API now supports filtering groups by name using a new filter_term field.

curl -i -X GET "https://api.box.com/2.0/groups?filter_term=Engineering" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Additionally, all the Group endpoints now allow a developer to request a new permissions field, which currently has one attribute defining if the authenticated user can invite the group to any item.

curl -i -X GET "https://api.box.com/2.0/groups?field=permissions" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

{
    "total_count": 1,
    "entries": [
        {
            "type": "group",
            "id": "223353242",
            "permissions": {
                "can_invite_as_collaborator": true
            }
        }
    ],
    "limit": 100,
    "offset": 0
}

For more details about how to work with groups, please visit the Group API documentation.

New featuresAPI

New multiSelect metadata support in search API

Starting today, the Search API adds support for matching items by multiple values of a multiSelect metadata field. Before this change, it was not possible to find items by the value of a multiSelect field.To perform a search for items where a metadata field matches multiple values, the mdfilters parameter now supports a list of values.

curl -G 'https://api.box.com/2.0/search' \
     -H 'Authorization: Bearer <ACCESS_TOKEN>' \
     -d 'mdfilters=[{"scope":"enterprise_12345","templateKey":"contractInfo","filters":{"products":["shield","platform")]}}]'

In this example, the mdfilters query parameter contains one filter with a scope, a templateKey, and a set of filters. Here is the same filter in a more readable format.

[
  {
    "scope": "enterprise_12345",
    "templateKey": "contractInfo",
    "filters": {
      "products": [
        "shield",
        "platform"
      ]
    }
  }
]

What is new here is that the products filter now performs a match on multiple values, only returning files and folders for which the template has a products value of either shield or platform. The value of the field can contain multiple values and only match on one of the values specified in the filter. For example ["shield", "governance"] will be a match for the filter ["shield", "platform"] as shield is included in the filter.

New featuresCLI

Box CLI v2.6.0 released

CHANGELOG

Add zip functionality (#203) 1953639
Add proxy support for http, https, socks and pac protocols. Proxy settings can be found under box configure:settings (#202) 21671c8
Fix filename issue when saving reports on Windows (#195) 31853d3

https://github.com/box/boxcli/compare/v2.5.1…v2.6.0

NodeSDKs

Box Node SDK v1.34.2 released

Make iterator bug fix for uploading files non breaking (#534) b0baa18

https://github.com/box/box-node-sdk/compare/v1.34.1…v1.34.2

JavaSDKs

Box Java SDK v2.50.1 released

Fix bug that occurred when downscoping a token for a Box folder (#832)

NodeSDKs

Box Node SDK v1.34.1 released

Fix iterator bug for uploading new file versions (#531) 69b1387

https://github.com/box/box-node-sdk/compare/v1.34.0…v1.34.1

New featuresNodeSDKs

Box Node SDK v1.34.0 released

Add zip functionality (#525) 2f89357
Add proxy support for HTTP, HTTPS, SOCKS and PAC protocols (#529) b08cc24

https://github.com/box/box-node-sdk/compare/v1.33.0…v1.34.0

New featuresAPI

Updates to Search Relevance & Performance

In January, updates were released to Box’s search tokenizer, improving the relevancy of search results and performance. This change does not effect how metadata is tokenized.Notable changes to the API-initiated searches include:

The ability to use “stop words”, for example (“the”), (“is”), (“at”), (“which”), and (“on”).
Improved Japanese text tokenization and improved search results.

See the full-text search documentation for more information on how to search using Box’s API.

New featuresAPI

New Zip Download APIs available

A new collection of APIs are now available that allows developers to create a Zip file containing a specified list of files and folders. We’ve updated the reference documentation for this Zip Download API. SDK support for these new endpoints is currently in development and scheduled to be released in the next 3 months.

New featuresJavaSDKs

Box Java SDK v2.50.0 released

Add retries on request creation errors (#828)

New featuresWindowsSDKs

Box Windows SDK v3.24.0 released

See Changelog for details.Commits: https://github.com/box/box-windows-sdk-v2/compare/v3.23.0…v3.24.0nuget.org/packages/Box.V2/3.24.0 nuget.org/packages/Box.V2.Core/3.24.0

New featuresJavaSDKs

Box Java SDK v2.49.0 released

Add fields parameter for metadata query (#826)
Add zip functionality (#825)
Fix bug with setting the unshared at date for a shared link (#819)

New featuresAPI

Change to enterprise events for content access

Starting today, the enterprise event stream will begin producing new content access events.A new CONTENT_ACCESS event is triggered when a file was accessed by an authorized user or programmatically by a Box application.See the enterprise events documentation for more information on other event types.

New featuresImpactful changesAPI

Changes to Metadata Query API syntax

The Metadata Query API has been updated to require explicitly defined response fields.

curl -X POST https://api.box.com/2.0/metadata_queries/execute_read \
      -H 'Authorization: Bearer <ACCESS_TOKEN>" '
      -H 'Content-Type: application/json'
      -d '{
        "from": "enterprise_123456.customerInfo",
        "query": "tav >= :value",
        "query_params": {
          "value": 200000
        },
        "fields": [
          "name",
          "metadata.enterprise_123456.customerInfo.tav"
       ],
        "ancestor_folder_id": "0"
      }'

Additionally, the response format now returns a list of items rather than a list of query results. Any metadata is now nested within the item, rather than listed side-by-side with the item. Only fields specified in the field array - as well as any base fields - are returned in the response.

{
  "entries": [{
    "id": "394384323",
    "type": "file",
    "etag": 1,
    "name": "Contract.pdf",
    "metadata": {
      "enterprise_123456": {
        "customerInfo": {
          "$parent": "folder_12345,",
          "$scope": "enterprise_123456",
          "$template": "customerInfo",
          "$version": 1,
          "tav": 1000000
        }
      }
    }
  }]
}

Legacy syntax

For reference, the API would previously return all standard fields for an item as well as the matched metadata.

curl -X POST https://api.box.com/2.0/metadata_queries/execute_read \
      -H 'Authorization: Bearer <ACCESS_TOKEN>" '
      -H 'Content-Type: application/json'
      -d '{
        "from": "enterprise_123456.customerInfo",
        "query": "tav >= :value",
        "query_params": {
          "value": 200000
        },
        "ancestor_folder_id": "0"
      }'

The response body previously returned the items as a list of entries, each containing an item and a metadata instance.

{
  "entries":[
    {
      "item":{
        "type":"file",
        "id":"394384323",
        "name": "Contract.pdf",
        "file_version":{
          "type":"file_version",
          "id":"33482348",
          "sha1":"69888bb1bff455d1b2f8afea75ed1ff0b4879bf6"
        },
        ...
      },
      "metadata":{
        "enterprise_123456":{
          "customerInfo":{
            "tav": 1000000,
            "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
            "$parent": "folder_12345,",
            "$scope": "enterprise_123456",
            "$template": "customerInfo",
            "$type": "customerInfo-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
            "$typeVersion": 2,
            "$version": 1,
            "$canEdit": true
          }
        }
      }
    },
    ...
  ],
  "limit": 20,
  "next_marker":"AAAAAmVYB1FWec8GH6yWu2nwmanfMh07IyYInaa7DZDYjgO1H4KoLW29vPlLY173OKsci6h6xGh61gG73gnaxoS+o0BbI1/h6le6cikjlupVhASwJ2Cj0tOD9wlnrUMHHw3/ISf+uuACzrOMhN6d5fYrbidPzS6MdhJOejuYlvsg4tcBYzjauP3+VU51p77HFAIuObnJT0ff"
}

This legacy syntax will still be available for any existing Metadata Query API users only. The legacy syntax will be turned off When all existing customers have been migrated over to the new syntax.

New featuresNodeSDKs

Box Node SDK v1.33.0 released

Add path parameter sanitization (#505) 46b780a
Add support for all streams for uploading files (#519) 93a27ec

https://github.com/box/box-node-sdk/compare/v1.32.0…v1.33.0

New featuresJavaSDKs

Box Java SDK v2.48.0 released

v2.48.0

Add ability to get groups by name with fields option (#789)
Add shared link downscoping (#785)
Deprecate the use of float for Metadata values, in preference of the underlying value (double) (#811)
Add iterator support for group collaborations (#813)
Add ability to set the filename when uploading a new version of a file (#810)
Add support for the classification field for Files and Folders (#809)
Add support for setting Tracking Codes (#766)
Fix issue for getIsExternallyOwned() for Files and Folders (#808)

New featuresPythonSDKs

Box Python SDK v2.9.0 released

Fix exception handling for OAuth
Fix path parameter sanitization

New featuresImpactful changesAPI

Change to enterprise events for tasks

Starting today, the enterprise event stream will begin producing new task and task assignment events, and some existing task events will return additional fields.

New events

A new TASK_UPDATE event is triggered when a task is updated
A new TASK_ASSIGNMENT_DELETE event is triggered when a task is unassigned from a user

Updated events

Changes to `TASK_CREATE`

When a task is created, the event now includes the task’s ID (task.id), the ID of the user who created the task (task.created_by.id), the task’s description (task.message), and the optional due date of the task (task.due_date) within the additional_details object.

"additional_details": {
  "task": {
    "id": "1234567",
    "due_at": "2020-07-06T10:49:44-07:00",
    "message": "task description",
    "created_by": {
      "id": 123456,
      "login": "email@example.com"
    },
    ...
  }
}

Changes to `TASK_ASSIGNMENT_CREATE` and `TASK_ASSIGNMENT_UPDATE`

When a task assignment is created or updated, the event now includes the task’s ID (task.id), the ID of the assigned user (task_assignment.assigned_to.id) and their login (task_assignment.assigned_to.login), the task’s description (task.message), and the optional due date of the task (task.due_date) within the additional_details object.

"additional_details": {
  "task": {
    "id": "1234567",
    "created_by": {
      "id": 12345,
      "login": "email@example.com"
    }
  },
  "task_assignment": {
    "assigned_to": {
      "id": 12346,
      "login": "email+2@example.com"
    },
    "status": "NOT_STARTED",
    "message": "assignee message"
  },
  ...
}

See the enterprise events documentation for more information on other event types.

New featuresiOSSDKs

Box iOS SDK v4.1.0 released

Breaking Changes:New Features and Enhancements:

Add ability to cancel uploads and downloads
Add support for the uploader display name field for Files and File Versions
Add support for the classification field for Files and Folders
Add path parameter sanitization

Bug Fixes:

Fix logging of API responses

New featuresWindowsSDKs

Windows .NET SDK v3.23.0 released

See Changelog for details Commits: v3.22.0...v3.23.0nuget.org/packages/Box.V2/3.23.0 nuget.org/packages/Box.V2.Core/3.23.0

New featuresAPI

New shield alert events

As of today, Box Shield will begin producing new security events within the enterprise event stream for Shield customers who are configured to listen for the new events.The possible incident events produced by Shield are:

Suspicious locations
Suspicious sessions
Anomalous download
Malicious content

See the shield alert events documentation for more information on the payloads produced within these events.

New featuresPythonSDKs

Python SDK v2.8.0 released

Added support for token exchange using shared links
Added the ability to pass in a SHA1 value for file uploads

New featuresAPI

New classification field for Files

A new optional field has been made available within the Field object, classification. This field represents the classification that is currently applied to a file.The classification can be requested via any endpoint that returns a file, like the Get file information and supports requesting additional fields.

{
  "id": "123456789",
  "type": "file",
  "etag": "1",
  "classification": {     
    "name": "Top Secret",     
    "definition": "Content that should not be shared outside the company.",
    "color": "#FF0000"
  },
  ...
}

The classification can be set through the API, Box Shield, or by a user using the web application.

New featuresJavaSDKs

Java SDK v2.47.0 released

Fix path parameter sanitization (#797)
Add support for the uploader display name field for Files and File version (#791)

New featuresAPI

Add new uploader_display_name field to file and file versions

A new field, uploader_display_name has been added to both file and file version resources. This field provides the name of the user at the time of upload.

{
  ...
  "uploader_display_name": "Ellis Wiggins"
}

This field can be requested on any of the file and file version endpoints by providing the fields query parameter, for example:

curl -X GET https://api.box.com/2.0/files/12345?fields=uploader_display_name \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

When the file is uploaded by a logged out anonymous, the email of the user is returned instead. If no email is available then the field will default to the text Someone.

New featuresAPI

New Metadata Query APIs available

A new API is now available that allows developers to query files and folders by the metadata attached to them. We’ve updated the reference documentation for this Metadata Query API, as well as released some brand new guides and an update to the metadata quick start guide.

New featuresCLI

Box CLI v2.5.1 released

CHANGELOG

Added --quiet flag to suppress any non-error output to stderr (#167) 27045c6
Fixed a bug for the --restrict-collaboration flag for box folders:update where previously the flag would not restrict the collaborations when passed as true and would restrict collaborations when passed as false (#175) e6e1120
Added box trash:restore to restore a trashed item and box trash:get to get information on a trashed item (#179) 74db947
Fixed a bug where flags that can be specified multiple times in a single command could not be passed through the command line for bulk commands (#183) 63db0ac
Note: Skipped version 2.5.0 due to development of new release process

v2.4.0...v2.5.1

New featuresJavaSDKs

Java SDK v2.46.0 released

Fix retry logic (#787)
Add path parameter sanitization (#790)
Add ability to set expiration date for a collaboration (#788)

New featuresJavaSDKs

Java SDK v2.45.0 released

Add preflight check before chunked uploads (#782)
Check that part was successfully uploaded for large file uploads… (#781)
Fix bug with unexpected disconnect in File Rename (#779)
Return metadata for each item returned by a metadata query (#778)

New featuresNodeSDKs

Node SDK v1.32.0 released

Temporarily removed Node 4 and Node 5 builds from Travis, due to tests not passing. Will investigate, going forward (#495). dc558e9
Fixed an issue where an error is thrown during a retry when a response is not returned by the previous call (#477). f1b3449
Added the ability to query Box items based on their metadata (#487). 6f08931

v1.31.0...v1.32.0

Impactful changesAPI

Potential impactful changes to format of Metadata date fields

As part of ongoing improvements to our Metadata infrastructure we will be rolling out three potential impactful changes to the format of date fields in metadata templates. These changes make the format our API returns more consistent between API calls.The first change affects the usage of time zone offsets in dates. Previously, the API would inconsistently return dates with and without timezone offsets if a date was set to include one. From now on all dates are converted to UTC / Zulu-time, removing the timezone offset.For example:

Assume a date was set to 2020-02-20T12:00:00.000-01:00
Previously the API would return 2020-02-20T12:00:00.000-01:00 (the original value) or 2020-02-20T13:00:00.000Z (the UTC adjusted value)
From now on it will always return 2020-02-20T13:00:00.000Z (the UTC adjusted value)

The second change affects the sub-second precision of dates returned by the metadata API. Previously, the API would return values with 0 to 3 digits of sub-second precision. From now on Box will always return metadata date-time values with millisecond precision.For example:

Previously the API might return 2020-02-20T12:00:00Z, 2020-02-20T12:00:00.0Z, 2020-02-20T12:00:00.00Zor 2020-02-20T12:00:00.000Z
From now on it will always return 2020-02-20T12:00:00.000Z

The final change affects the usage of the test operation when updating a metadata instance. Previously the test would compare the date-time values using the literal string value. After this update they are compared using their UNIX timestamp in milliseconds.For example:

Previously 2020-01-21T19:20:00.123-08:00 would not be equivalent to 2020-01-22T03:20:00.123Z
From now on 2020-01-21T19:20:00.123-08:00 is equivalent to 2020-01-22T03:20:00.123Z

How this can affect an application

Any application that implements RFC3339-compliant date-time parsing will not need to perform any action as these are all valid RFC3339 values representing the same dates. Any application that does not implement RFC3339 compliant date-time parsing should be updated to do so.All official Box SDKs support RFC3339-compliant date-time parsing, so any application using an up-to-date version of an official Box SDK would not require any update.

What do if this affected your application

Roll-out of this change will be performed gradually over the next few weeks. Although the metadata team will be monitoring potential impact, please reach out to your customer success manager or our support channels if you find yourself impacted.

Impactful changesAPI

Change to metadata instance version

As part of ongoing improvements to our Metadata infrastructure we will be rolling out a small change to the version value of a metadata Instance.Previously, the version number associated with a metadata instance would be incremented if a field on the associated metadata template was deleted, or if an enum field’s option was deleted on the associated metadata template.Going forward, these changes will not increment the version number of a metadata instance.This behavior has always been implicit and we recognize that very little value can be derived form to the metadata instance version. Therefore we do not expect this change to have any impact on any of our customers. Regardless, please reach out to your customer success manager or our support channels if you find yourself impacted.

New featuresWindowsSDKs

Windows .NET SDK v3.22.0 Released

See Changelog for details Commits: v3.21.0...v3.22.0nuget.org/packages/Box.V2/3.22.0 nuget.org/packages/Box.V2.Core/3.22.0

New featuresNodeSDKs

Node SDK v1.31.0 released

Fix Authentication Request Retries (#454) dd3253e
Added marker-based paging for users endpoints (#461) 055cb5b
Added getNextMarker() to PagingIterator to get the next marker (#461) 055cb5b

v1.30.0...v1.31.0

JavaSDKs

Java SDK v2.44.1 Released

Fix formatting bug for Java Logger (#775)
Improve date / time parsing for responses (#772)

New featuresImpactful changesiOSSDKs

Box iOS SDK v4.0.0 released

Breaking Changes:

Change status field for task assignments from a String to an Enum
Remove macOS, tvOS, and watchOS support

New Features and Enhancements:

Make authentication session classes OAuth2Session, SingleTokenSession, and DelegatedAuthSession public

SDKsContent preview

Preview SDK v2.34.0 released

Version 2.34.0 of the Preview SDK has been released. New JavaScript and CSS Preview files have been made available. To adopt new changes, please see the UI Elements manual installation links for Content Preview.Please see the v2.34.0 release notes for a list of all feature changes.

PythonSDKs

Python SDK v2.7.1 released

Fixed bug in _get_retry_request_callable introduced in release 2.7.0 which caused chunked uploads to fail

SDKsContent preview

Preview SDK v2.33.1 released

Version 2.33.1 of the Preview SDK has been released. New JavaScript and CSS Preview files have been made available. To adopt new changes, please see the UI Elements manual installation links for Content Preview.Please see the v2.33.1 release notes for a list of all feature changes.

New featuresJavaSDKs

Java SDK v2.44.0 released

Fix Authentication Request Retries (#764)

Postman

Refreshed Postman Collection & Quick Start

The Box Postman collection has been updated with new features and an integrated quick-start guide. Key features include:

An end-to-end Postman quick-start guide that helps users to install Postman, set up a Box App, and load their API credentials into Postman.
A restructured Postman collection for the Box APIs that automatically detects when API credentials have expired and offers integrated solutions for refreshing these credentials when needed.

The legacy Postman collection will stay available for the foreseeable future.

New featuresPythonSDKs

Python SDK v2.7.0 released

Fixed bug in get_admin_events function which caused errors when the optional event_types parameter was omitted.
Add marker based pagination for listing users.
Added support for more attribute parameters when uploading new files and new versions of existing files.
Combined preflight check and lookup of accelerator URL into a single request for uploads.
Fixed JWT retry logic so a new JTI claim is generated on each retry.
Fixed bug where JWT authentication requests returned incorrect error codes.
Fixed retry logic so when a Retry-After header is passed back from the API, the SDK waits for the amount of time specified in the header before retrying.

​Blank OAuth 2 redirect URI change

​How to update your OAuth 2 app redirect URI

​New type field in search API responses

​Updates

​Box CLI v2.8.0 released

​Warning

​New Features and Enhancements

​Bug Fixes

​Box Java SDK v2.52.0 released

​New Features and Enhancements

​Bug Fixes

​Announcing Client Credentials Grant authentication

​Updates

​Box iOS SDK v4.2.0 released

​Breaking Changes

​New Features and Enhancements

​Bug Fixes

​Box Java SDK v2.51.1 released

​Bug Fixes

​Box Content Preview v2.57.0 released

​New Features and Enhancements

​Bug Fixes

​Simplified App Creation Flow

​Box CLI v2.7.0 released

​New Features and Enhancements

​Bug Fixes

​Box Node SDK v1.35.0 released

​New Features and Enhancements

​Box Java SDK v2.51.0 released

​New Features and Enhancements

​Bug Fixes

​New Folder Lock APIs now available

​New Folder Lock APIs now available

​Metadata Cascade Policies API leaves Beta

​Box Windows SDK v3.25.0 released

​New Features and Enhancements

​Bug Fixes

​Search API adds support for Shared Links

​Change in response format

​Box Node SDK v1.34.3 released

​Bug Fixes

​New File Request APIs available

​Box Python SDK v2.10.0 released

​New Features and Enhancements

​Bug Fixes

​Change to OAuth 2 app redirect URI requirements

​How to validate and make the change

​Search API adds support for Shared Links

​Change in response format

​Group API adds new filter and permissions

​New multiSelect metadata support in search API

​Box CLI v2.6.0 released

​Box Node SDK v1.34.2 released

​Box Java SDK v2.50.1 released

​Box Node SDK v1.34.1 released

​Box Node SDK v1.34.0 released

​Updates to Search Relevance & Performance

​New Zip Download APIs available

​Box Java SDK v2.50.0 released

​Box Windows SDK v3.24.0 released

​Box Java SDK v2.49.0 released

​Change to enterprise events for content access

​Changes to Metadata Query API syntax

​Legacy syntax

​Box Node SDK v1.33.0 released

​Box Java SDK v2.48.0 released

​Box Python SDK v2.9.0 released

​Change to enterprise events for tasks

​New events

​Updated events

​Changes to TASK_CREATE

​Changes to TASK_ASSIGNMENT_CREATE and TASK_ASSIGNMENT_UPDATE

​Box iOS SDK v4.1.0 released

​Windows .NET SDK v3.23.0 released

​New shield alert events

​Python SDK v2.8.0 released

​New classification field for Files

​Java SDK v2.47.0 released

​Add new uploader_display_name field to file and file versions

​New Metadata Query APIs available

Blank OAuth 2 redirect URI change

How to update your OAuth 2 app redirect URI

New type field in search API responses

Updates

Box CLI v2.8.0 released

Warning

New Features and Enhancements

Bug Fixes

Box Java SDK v2.52.0 released

New Features and Enhancements

Bug Fixes

Announcing Client Credentials Grant authentication

Updates

Box iOS SDK v4.2.0 released

Breaking Changes

New Features and Enhancements

Bug Fixes

Box Java SDK v2.51.1 released

Bug Fixes

Box Content Preview v2.57.0 released

New Features and Enhancements

Bug Fixes

Simplified App Creation Flow

Box CLI v2.7.0 released

New Features and Enhancements

Bug Fixes

Box Node SDK v1.35.0 released

New Features and Enhancements

Box Java SDK v2.51.0 released

New Features and Enhancements

Bug Fixes

New Folder Lock APIs now available

New Folder Lock APIs now available

Metadata Cascade Policies API leaves Beta

Box Windows SDK v3.25.0 released

New Features and Enhancements

Bug Fixes

Search API adds support for Shared Links

Change in response format

Box Node SDK v1.34.3 released

Bug Fixes

New File Request APIs available

Box Python SDK v2.10.0 released

New Features and Enhancements

Bug Fixes

Change to OAuth 2 app redirect URI requirements

How to validate and make the change

Search API adds support for Shared Links

Change in response format

Group API adds new filter and permissions

New multiSelect metadata support in search API

Box CLI v2.6.0 released

Box Node SDK v1.34.2 released

Box Java SDK v2.50.1 released

Box Node SDK v1.34.1 released

Box Node SDK v1.34.0 released

Updates to Search Relevance & Performance

New Zip Download APIs available

Box Java SDK v2.50.0 released

Box Windows SDK v3.24.0 released

Box Java SDK v2.49.0 released

Change to enterprise events for content access

Changes to Metadata Query API syntax

Legacy syntax

Box Node SDK v1.33.0 released

Box Java SDK v2.48.0 released

Box Python SDK v2.9.0 released

Change to enterprise events for tasks

New events

Updated events

Changes to `TASK_CREATE`

Changes to `TASK_ASSIGNMENT_CREATE` and `TASK_ASSIGNMENT_UPDATE`

Box iOS SDK v4.1.0 released

Windows .NET SDK v3.23.0 released

New shield alert events

Python SDK v2.8.0 released

New classification field for Files

Java SDK v2.47.0 released

Add new uploader_display_name field to file and file versions

New Metadata Query APIs available