Skip to content

hubs.md

Latest commit

 

History

History
224 lines (135 loc) · 6.22 KB

hubs.md

File metadata and controls

224 lines (135 loc) · 6.22 KB

HubsManager

List all Box Hubs

Retrieves all Box Hubs for requesting user.

This operation is performed by calling function getHubsV2025R0.

See the endpoint docs at API Reference.

client.getHubs().getHubsV2025R0(new GetHubsV2025R0QueryParams.Builder().scope("all").sort("name").direction(GetHubsV2025R0QueryParamsDirectionField.ASC).build())

Arguments

  • queryParams GetHubsV2025R0QueryParams
    • Query parameters of getHubsV2025R0 method
  • headers GetHubsV2025R0Headers
    • Headers of getHubsV2025R0 method

Returns

This function returns a value of type HubsV2025R0.

Returns all Box Hubs for the given user or enterprise.

Create Box Hub

Creates a new Box Hub.

This operation is performed by calling function createHubV2025R0.

See the endpoint docs at API Reference.

client.getHubs().createHubV2025R0(new HubCreateRequestV2025R0.Builder(hubTitle).description(hubDescription).build())

Arguments

  • requestBody HubCreateRequestV2025R0
    • Request body of createHubV2025R0 method
  • headers CreateHubV2025R0Headers
    • Headers of createHubV2025R0 method

Returns

This function returns a value of type HubV2025R0.

Returns a new Hub object.

List all Box Hubs for requesting enterprise

Retrieves all Box Hubs for a given enterprise.

Admins or Hub Co-admins of an enterprise with GCM scope can make this call.

This operation is performed by calling function getEnterpriseHubsV2025R0.

See the endpoint docs at API Reference.

client.getHubs().getEnterpriseHubsV2025R0(new GetEnterpriseHubsV2025R0QueryParams.Builder().sort("name").direction(GetEnterpriseHubsV2025R0QueryParamsDirectionField.ASC).build())

Arguments

  • queryParams GetEnterpriseHubsV2025R0QueryParams
    • Query parameters of getEnterpriseHubsV2025R0 method
  • headers GetEnterpriseHubsV2025R0Headers
    • Headers of getEnterpriseHubsV2025R0 method

Returns

This function returns a value of type HubsV2025R0.

Returns all Box Hubs for the given user or enterprise.

Get Box Hub information by ID

Retrieves details for a Box Hub by its ID.

This operation is performed by calling function getHubByIdV2025R0.

See the endpoint docs at API Reference.

client.getHubs().getHubByIdV2025R0(hubId)

Arguments

  • hubId String
    • The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/hubs/123 the hub_id is 123. Example: "12345"
  • headers GetHubByIdV2025R0Headers
    • Headers of getHubByIdV2025R0 method

Returns

This function returns a value of type HubV2025R0.

Returns a hub object.

Update Box Hub information by ID

Updates a Box Hub. Can be used to change title, description, or Box Hub settings.

This operation is performed by calling function updateHubByIdV2025R0.

See the endpoint docs at API Reference.

client.getHubs().updateHubByIdV2025R0(hubId, new HubUpdateRequestV2025R0.Builder().title(newHubTitle).description(newHubDescription).build())

Arguments

  • hubId String
    • The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/hubs/123 the hub_id is 123. Example: "12345"
  • requestBody HubUpdateRequestV2025R0
    • Request body of updateHubByIdV2025R0 method
  • headers UpdateHubByIdV2025R0Headers
    • Headers of updateHubByIdV2025R0 method

Returns

This function returns a value of type HubV2025R0.

Returns a Hub object.

Delete Box Hub

Deletes a single Box Hub.

This operation is performed by calling function deleteHubByIdV2025R0.

See the endpoint docs at API Reference.

client.getHubs().deleteHubByIdV2025R0(hubId)

Arguments

  • hubId String
    • The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/hubs/123 the hub_id is 123. Example: "12345"
  • headers DeleteHubByIdV2025R0Headers
    • Headers of deleteHubByIdV2025R0 method

Returns

This function returns a value of type void.

A blank response is returned if the hub was successfully deleted.

Copy Box Hub

Creates a copy of a Box Hub.

The original Box Hub will not be modified.

This operation is performed by calling function copyHubV2025R0.

See the endpoint docs at API Reference.

client.getHubs().copyHubV2025R0(createdHub.getId(), new HubCopyRequestV2025R0.Builder().title(copiedHubTitle).description(copiedHubDescription).build())

Arguments

  • hubId String
    • The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/hubs/123 the hub_id is 123. Example: "12345"
  • requestBody HubCopyRequestV2025R0
    • Request body of copyHubV2025R0 method
  • headers CopyHubV2025R0Headers
    • Headers of copyHubV2025R0 method

Returns

This function returns a value of type HubV2025R0.

Returns a new Hub object.