Box Developer Documentation
Log in
Latest version

Get storage policy assignment

get
https://api.box.com/2.0
/storage_policy_assignments/:storage_policy_assignment_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Fetches a specific storage policy assignment.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
932483

The ID of the storage policy assignment.

Response

application/jsonStorage policy assignment

Returns a storage policy assignment object.

application/jsonClient error

An unexpected client error.

get
Get storage policy assignment
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/storage_policy_assignments/932483" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.storagePolicyAssignments.getStoragePolicyAssignmentById(
  storagePolicyAssignment.id,
);
Python Gen
client.storage_policy_assignments.get_storage_policy_assignment_by_id(
    storage_policy_assignment.id
)
.NET Gen
await client.StoragePolicyAssignments.GetStoragePolicyAssignmentByIdAsync(storagePolicyAssignmentId: storagePolicyAssignment.Id);
Swift Gen (Beta)
try await client.storagePolicyAssignments.getStoragePolicyAssignmentById(storagePolicyAssignmentId: storagePolicyAssignment.id)
Java
BoxStoragePolicyAssignment storagePolicyAssignment = new BoxStoragePolicyAssignment(api, id);
BoxStoragePolicyAssignment.Info assignmentInfo = storagePolicyAssignment.getInfo();
Python
assignment = client.storage_policy_assignment(assignment_id='12345').get()
print(f'Assignment ID is {assignment.id} and the storage policy ID is {assignment.storage_policy.id}')
.NET
BoxStoragePolicyAssignment assignment = await client.StoragePoliciesManager
    .GetAssignmentAsync(assignmentId: "dXNlcl8yMjIyMg==");
Node
client.storagePolicies.getAssignment('dXNlcl8yMjIyMg==')
    .then(assignment => {
        /* assignment -> {
            type: 'storage_policy_assignment',
            id: 'dXNlcl8yMjIyMg==',
            storage_policy: 'storage_policy', id: '7' },
            assigned_to: { type: 'user', id: '22222' } }
        */
    });
iOS
client.storagePolicy.getAssignment(storagePolicyAssignmentId: "1234") { (result: Result<StoragePolicyAssignment, BoxSDKError>) in
    guard case let .success(assignment) = result else {
        print("Error getting storage policy assignment")
        return
    }
    print("Storage policy assignment ID \(assignment.id)")
}

Response Example

{
  "id": "ZW50ZXJwcmlzZV8xMjM0NTY3ODkw",
  "type": "storage_policy_assignment",
  "assigned_to": {
    "id": "11446498",
    "type": "file"
  },
  "storage_policy": {
    "id": "11446498",
    "type": "storage_policy"
  }
}