GET assets/{id}/vault

Returns asset data vault structure.

Request

URL ( doesn't require authentication )

https://api.crexi.com/assets/{id}/vault?forEdit={forEdit}

Parameters

forEdit

boolean

Optional

Default value is False

id

integer

Asset Id

Required

Response

Details

Returns an HTTP 200 OK and asset vault structure. Returns 400 Bad Request and an error if Id parameter is invalid.

Data fields

EmptyVaultCopy

string

Tier1

VaultTierData

Tier2

VaultTierData

TotalSize

integer

UsedSize

integer

UserCanDownloadAll

boolean

VaultAccessStatus

string

Example

JSON

{
  "EmptyVaultCopy": "Some replacement for vault",
  "Tier1": {
    "AccessStatus": "Granted",
    "Files": [
      {
        "CreatedOn": "0001-01-01T00:00:00Z",
        "Id": 1,
        "IsNew": false,
        "IsPrivate": false,
        "Name": "Document1.pdf",
        "Size": 0,
        "Type": "File",
        "UserHasAccess": false
      },
      {
        "Children": [
          {
            "CreatedOn": "0001-01-01T00:00:00Z",
            "Id": 2,
            "IsNew": false,
            "IsPrivate": false,
            "Name": "Document2.pdf",
            "Size": 200,
            "Type": "File",
            "UserHasAccess": false
          },
          {
            "Children": [
              {
                "CreatedOn": "0001-01-01T00:00:00Z",
                "Id": 3,
                "IsNew": false,
                "IsPrivate": false,
                "Name": "Document3.pdf",
                "Size": 0,
                "Type": "File",
                "UserHasAccess": false
              }
            ],
            "CreatedOn": "0001-01-01T00:00:00Z",
            "Id": 0,
            "IsNew": false,
            "IsPrivate": false,
            "Name": "Folder2",
            "Type": "Folder",
            "UserHasAccess": false
          }
        ],
        "CreatedOn": "0001-01-01T00:00:00Z",
        "Id": 0,
        "IsNew": false,
        "IsPrivate": false,
        "Name": "Folder1",
        "Type": "Folder",
        "UserHasAccess": false
      }
    ]
  },
  "Tier2": {
    "AccessStatus": "Granted",
    "Files": [
      {
        "CreatedOn": "0001-01-01T00:00:00Z",
        "Id": 1,
        "IsNew": false,
        "IsPrivate": false,
        "Name": "Document1.pdf",
        "Size": 0,
        "Type": "File",
        "UserHasAccess": false
      },
      {
        "Children": [
          {
            "CreatedOn": "0001-01-01T00:00:00Z",
            "Id": 2,
            "IsNew": false,
            "IsPrivate": false,
            "Name": "Document2.pdf",
            "Size": 200,
            "Type": "File",
            "UserHasAccess": false
          },
          {
            "Children": [
              {
                "CreatedOn": "0001-01-01T00:00:00Z",
                "Id": 3,
                "IsNew": false,
                "IsPrivate": false,
                "Name": "Document3.pdf",
                "Size": 0,
                "Type": "File",
                "UserHasAccess": false
              }
            ],
            "CreatedOn": "0001-01-01T00:00:00Z",
            "Id": 0,
            "IsNew": false,
            "IsPrivate": false,
            "Name": "Folder2",
            "Type": "Folder",
            "UserHasAccess": false
          }
        ],
        "CreatedOn": "0001-01-01T00:00:00Z",
        "Id": 0,
        "IsNew": false,
        "IsPrivate": false,
        "Name": "Folder1",
        "Type": "Folder",
        "UserHasAccess": false
      }
    ]
  },
  "TotalSize": 0,
  "UsedSize": 400,
  "UserCanDownloadAll": false,
  "VaultAccessStatus": "Granted"
}