Assets API: Files

Retrieves one specific file

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

filestring · uuidRequired

Responses

200

OK

application/jsontext/json

ApprovedUserIdstring · uuid · nullableOptional

FileIdstring · uuidOptional

LastActivityUserIdstring · uuid · nullableOptional

ObjectIdstring · uuidOptional

ReviewedUserIdstring · uuid · nullableOptional

UserIdstring · uuidOptional

DocumentNamestring · nullableOptional

FileCategorystring · nullableOptional

FileContentTypestring · nullableOptional

FileDescriptionstring · nullableOptional

FileLocationstring · nullableOptional

FileNamestring · nullableOptional

FilePathstring · nullableOptional

FileStatusstring · nullableOptional

FileSubcategorystring · nullableOptional

FileUrlstring · nullableOptional

ObjectTypestring · nullableOptional

FileSizeinteger · int32Optional

ApprovedTimestring · date-time · nullableOptional

FileAlternatedstring · date-time · nullableOptional

FileExpirystring · date-time · nullableOptional

FileReceivedstring · date-time · nullableOptional

FileUploadedstring · date-timeOptional

LastActivityTimestring · date-time · nullableOptional

ReviewedTimestring · date-time · nullableOptional

404

Not Found

application/jsontext/json

get/api/assets/files/{file}

HTTPcURLJavaScriptPython

GET /v2/e01/api/assets/files/{file} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "ApprovedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileId": "123e4567-e89b-12d3-a456-426614174000",
  "LastActivityUserId": "123e4567-e89b-12d3-a456-426614174000",
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ReviewedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "DocumentName": "text",
  "FileCategory": "text",
  "FileContentType": "text",
  "FileDescription": "text",
  "FileLocation": "text",
  "FileName": "text",
  "FilePath": "text",
  "FileStatus": "text",
  "FileSubcategory": "text",
  "FileUrl": "text",
  "ObjectType": "text",
  "FileSize": 1,
  "ApprovedTime": "2026-08-10T15:50:46.041Z",
  "FileAlternated": "2026-08-10T15:50:46.041Z",
  "FileExpiry": "2026-08-10T15:50:46.041Z",
  "FileReceived": "2026-08-10T15:50:46.041Z",
  "FileUploaded": "2026-08-10T15:50:46.041Z",
  "LastActivityTime": "2026-08-10T15:50:46.041Z",
  "ReviewedTime": "2026-08-10T15:50:46.041Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

filestring · uuidRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ApprovedUserIdstring · uuid · nullableOptional

FileIdstring · uuidOptional

LastActivityUserIdstring · uuid · nullableOptional

ObjectIdstring · uuidOptional

ReviewedUserIdstring · uuid · nullableOptional

UserIdstring · uuidOptional

DocumentNamestring · nullableOptional

FileCategorystring · nullableOptional

FileContentTypestring · nullableOptional

FileDescriptionstring · nullableOptional

FileLocationstring · nullableOptional

FileNamestring · nullableOptional

FilePathstring · nullableOptional

FileStatusstring · nullableOptional

FileSubcategorystring · nullableOptional

FileUrlstring · nullableOptional

ObjectTypestring · nullableOptional

FileSizeinteger · int32Optional

ApprovedTimestring · date-time · nullableOptional

FileAlternatedstring · date-time · nullableOptional

FileExpirystring · date-time · nullableOptional

FileReceivedstring · date-time · nullableOptional

FileUploadedstring · date-timeOptional

LastActivityTimestring · date-time · nullableOptional

ReviewedTimestring · date-time · nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/jsontext/json

put/api/assets/files/{file}

HTTPcURLJavaScriptPython

PUT /v2/e01/api/assets/files/{file} HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 864

{
  "ApprovedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileId": "123e4567-e89b-12d3-a456-426614174000",
  "LastActivityUserId": "123e4567-e89b-12d3-a456-426614174000",
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ReviewedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "DocumentName": "text",
  "FileCategory": "text",
  "FileContentType": "text",
  "FileDescription": "text",
  "FileLocation": "text",
  "FileName": "text",
  "FilePath": "text",
  "FileStatus": "text",
  "FileSubcategory": "text",
  "FileUrl": "text",
  "ObjectType": "text",
  "FileSize": 1,
  "ApprovedTime": "2026-08-10T15:50:46.041Z",
  "FileAlternated": "2026-08-10T15:50:46.041Z",
  "FileExpiry": "2026-08-10T15:50:46.041Z",
  "FileReceived": "2026-08-10T15:50:46.041Z",
  "FileUploaded": "2026-08-10T15:50:46.041Z",
  "LastActivityTime": "2026-08-10T15:50:46.041Z",
  "ReviewedTime": "2026-08-10T15:50:46.041Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

Path parameters

filestring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

delete/api/assets/files/{file}

HTTPcURLJavaScriptPython

DELETE /v2/e01/api/assets/files/{file} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Checks for the existence of one specific file

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

filestring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

head/api/assets/files/{file}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/assets/files/{file} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of files that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

FileIdsstring · uuid[] · nullableOptional

ObjectTypeExactstring · nullableOptional

ObjectIdentifierContainsstring · nullableOptional

FileNameContainsstring · nullableOptional

DocumentNameContainsstring · nullableOptional

FileUploadedSincestring · date-time · nullableOptional

FileUploadedBeforestring · date-time · nullableOptional

HasClaimsboolean · nullableOptional

FileTagstring · enumOptionalPossible values:

Responses

200

OK

application/jsontext/json

ApprovedUserIdstring · uuid · nullableOptional

FileIdstring · uuidOptional

LastActivityUserIdstring · uuid · nullableOptional

ObjectIdstring · uuidOptional

ReviewedUserIdstring · uuid · nullableOptional

UserIdstring · uuidOptional

DocumentNamestring · nullableOptional

FileCategorystring · nullableOptional

FileContentTypestring · nullableOptional

FileDescriptionstring · nullableOptional

FileLocationstring · nullableOptional

FileNamestring · nullableOptional

FilePathstring · nullableOptional

FileStatusstring · nullableOptional

FileSubcategorystring · nullableOptional

FileUrlstring · nullableOptional

ObjectTypestring · nullableOptional

FileSizeinteger · int32Optional

ApprovedTimestring · date-time · nullableOptional

FileAlternatedstring · date-time · nullableOptional

FileExpirystring · date-time · nullableOptional

FileReceivedstring · date-time · nullableOptional

FileUploadedstring · date-timeOptional

LastActivityTimestring · date-time · nullableOptional

ReviewedTimestring · date-time · nullableOptional

post/api/assets/files/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/assets/files/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 402

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ObjectTypeExact": "text",
  "ObjectIdentifierContains": "text",
  "FileNameContains": "text",
  "DocumentNameContains": "text",
  "FileUploadedSince": "2026-08-10T15:50:46.041Z",
  "FileUploadedBefore": "2026-08-10T15:50:46.041Z",
  "HasClaims": true,
  "FileTag": "PersonImport"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "ApprovedUserId": "123e4567-e89b-12d3-a456-426614174000",
    "FileId": "123e4567-e89b-12d3-a456-426614174000",
    "LastActivityUserId": "123e4567-e89b-12d3-a456-426614174000",
    "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
    "ReviewedUserId": "123e4567-e89b-12d3-a456-426614174000",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "DocumentName": "text",
    "FileCategory": "text",
    "FileContentType": "text",
    "FileDescription": "text",
    "FileLocation": "text",
    "FileName": "text",
    "FilePath": "text",
    "FileStatus": "text",
    "FileSubcategory": "text",
    "FileUrl": "text",
    "ObjectType": "text",
    "FileSize": 1,
    "ApprovedTime": "2026-08-10T15:50:46.041Z",
    "FileAlternated": "2026-08-10T15:50:46.041Z",
    "FileExpiry": "2026-08-10T15:50:46.041Z",
    "FileReceived": "2026-08-10T15:50:46.041Z",
    "FileUploaded": "2026-08-10T15:50:46.041Z",
    "LastActivityTime": "2026-08-10T15:50:46.041Z",
    "ReviewedTime": "2026-08-10T15:50:46.041Z"
  }
]

Counts the files that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

FileIdsstring · uuid[] · nullableOptional

ObjectTypeExactstring · nullableOptional

ObjectIdentifierContainsstring · nullableOptional

FileNameContainsstring · nullableOptional

DocumentNameContainsstring · nullableOptional

FileUploadedSincestring · date-time · nullableOptional

FileUploadedBeforestring · date-time · nullableOptional

HasClaimsboolean · nullableOptional

FileTagstring · enumOptionalPossible values:

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/assets/files/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/assets/files/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 402

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ObjectTypeExact": "text",
  "ObjectIdentifierContains": "text",
  "FileNameContains": "text",
  "DocumentNameContains": "text",
  "FileUploadedSince": "2026-08-10T15:50:46.041Z",
  "FileUploadedBefore": "2026-08-10T15:50:46.041Z",
  "HasClaims": true,
  "FileTag": "PersonImport"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of files that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

FileIdsstring · uuid[] · nullableOptional

ObjectTypeExactstring · nullableOptional

ObjectIdentifierContainsstring · nullableOptional

FileNameContainsstring · nullableOptional

DocumentNameContainsstring · nullableOptional

FileUploadedSincestring · date-time · nullableOptional

FileUploadedBeforestring · date-time · nullableOptional

HasClaimsboolean · nullableOptional

FileTagstring · enumOptionalPossible values:

Responses

200

OK

No content

post/api/assets/files/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/assets/files/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 402

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ObjectTypeExact": "text",
  "ObjectIdentifierContains": "text",
  "FileNameContains": "text",
  "DocumentNameContains": "text",
  "FileUploadedSince": "2026-08-10T15:50:46.041Z",
  "FileUploadedBefore": "2026-08-10T15:50:46.041Z",
  "HasClaims": true,
  "FileTag": "PersonImport"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of files that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ObjectIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

FileIdsstring · uuid[] · nullableOptional

ObjectTypeExactstring · nullableOptional

ObjectIdentifierContainsstring · nullableOptional

FileNameContainsstring · nullableOptional

DocumentNameContainsstring · nullableOptional

FileUploadedSincestring · date-time · nullableOptional

FileUploadedBeforestring · date-time · nullableOptional

HasClaimsboolean · nullableOptional

FileTagstring · enumOptionalPossible values:

Responses

200

OK

application/jsontext/json

OrganizationCodestring · nullableOptional

ObjectTypestring · nullableOptional

ObjectIdstring · uuidOptional

FileIdstring · uuidOptional

FileLocationstring · nullableOptional

FileNamestring · nullableOptional

DocumentNamestring · nullableOptional

FileSizeinteger · int32Optional

FileUploadedstring · date-timeOptional

UserIdstring · uuidOptional

UserFullNamestring · nullableOptional

FileTagstring · nullableOptional

HasClaimsbooleanOptional

post/api/assets/files/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/assets/files/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 402

{
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "ObjectTypeExact": "text",
  "ObjectIdentifierContains": "text",
  "FileNameContains": "text",
  "DocumentNameContains": "text",
  "FileUploadedSince": "2026-08-10T15:50:46.041Z",
  "FileUploadedBefore": "2026-08-10T15:50:46.041Z",
  "HasClaims": true,
  "FileTag": "PersonImport"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "OrganizationCode": "text",
    "ObjectType": "text",
    "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
    "FileId": "123e4567-e89b-12d3-a456-426614174000",
    "FileLocation": "text",
    "FileName": "text",
    "DocumentName": "text",
    "FileSize": 1,
    "FileUploaded": "2026-08-10T15:50:46.041Z",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "UserFullName": "text",
    "FileTag": "text",
    "HasClaims": true
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ApprovedUserIdstring · uuid · nullableOptional

FileIdstring · uuidOptional

LastActivityUserIdstring · uuid · nullableOptional

ObjectIdstring · uuidOptional

ReviewedUserIdstring · uuid · nullableOptional

UserIdstring · uuidOptional

DocumentNamestring · nullableOptional

FileCategorystring · nullableOptional

FileContentTypestring · nullableOptional

FileDescriptionstring · nullableOptional

FileLocationstring · nullableOptional

FileNamestring · nullableOptional

FilePathstring · nullableOptional

FileStatusstring · nullableOptional

FileSubcategorystring · nullableOptional

FileUrlstring · nullableOptional

ObjectTypestring · nullableOptional

FileSizeinteger · int32Optional

ApprovedTimestring · date-time · nullableOptional

FileAlternatedstring · date-time · nullableOptional

FileExpirystring · date-time · nullableOptional

FileReceivedstring · date-time · nullableOptional

FileUploadedstring · date-timeOptional

LastActivityTimestring · date-time · nullableOptional

ReviewedTimestring · date-time · nullableOptional

Responses

201

Created

application/json

ApprovedUserIdstring · uuid · nullableOptional

FileIdstring · uuidOptional

LastActivityUserIdstring · uuid · nullableOptional

ObjectIdstring · uuidOptional

ReviewedUserIdstring · uuid · nullableOptional

UserIdstring · uuidOptional

DocumentNamestring · nullableOptional

FileCategorystring · nullableOptional

FileContentTypestring · nullableOptional

FileDescriptionstring · nullableOptional

FileLocationstring · nullableOptional

FileNamestring · nullableOptional

FilePathstring · nullableOptional

FileStatusstring · nullableOptional

FileSubcategorystring · nullableOptional

FileUrlstring · nullableOptional

ObjectTypestring · nullableOptional

FileSizeinteger · int32Optional

ApprovedTimestring · date-time · nullableOptional

FileAlternatedstring · date-time · nullableOptional

FileExpirystring · date-time · nullableOptional

FileReceivedstring · date-time · nullableOptional

FileUploadedstring · date-timeOptional

LastActivityTimestring · date-time · nullableOptional

ReviewedTimestring · date-time · nullableOptional

400

Bad Request

application/json

post/api/assets/files

HTTPcURLJavaScriptPython

POST /v2/e01/api/assets/files HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 864

{
  "ApprovedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileId": "123e4567-e89b-12d3-a456-426614174000",
  "LastActivityUserId": "123e4567-e89b-12d3-a456-426614174000",
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ReviewedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "DocumentName": "text",
  "FileCategory": "text",
  "FileContentType": "text",
  "FileDescription": "text",
  "FileLocation": "text",
  "FileName": "text",
  "FilePath": "text",
  "FileStatus": "text",
  "FileSubcategory": "text",
  "FileUrl": "text",
  "ObjectType": "text",
  "FileSize": 1,
  "ApprovedTime": "2026-08-10T15:50:46.041Z",
  "FileAlternated": "2026-08-10T15:50:46.041Z",
  "FileExpiry": "2026-08-10T15:50:46.041Z",
  "FileReceived": "2026-08-10T15:50:46.041Z",
  "FileUploaded": "2026-08-10T15:50:46.041Z",
  "LastActivityTime": "2026-08-10T15:50:46.041Z",
  "ReviewedTime": "2026-08-10T15:50:46.041Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "ApprovedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "FileId": "123e4567-e89b-12d3-a456-426614174000",
  "LastActivityUserId": "123e4567-e89b-12d3-a456-426614174000",
  "ObjectId": "123e4567-e89b-12d3-a456-426614174000",
  "ReviewedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "DocumentName": "text",
  "FileCategory": "text",
  "FileContentType": "text",
  "FileDescription": "text",
  "FileLocation": "text",
  "FileName": "text",
  "FilePath": "text",
  "FileStatus": "text",
  "FileSubcategory": "text",
  "FileUrl": "text",
  "ObjectType": "text",
  "FileSize": 1,
  "ApprovedTime": "2026-08-10T15:50:46.041Z",
  "FileAlternated": "2026-08-10T15:50:46.041Z",
  "FileExpiry": "2026-08-10T15:50:46.041Z",
  "FileReceived": "2026-08-10T15:50:46.041Z",
  "FileUploaded": "2026-08-10T15:50:46.041Z",
  "LastActivityTime": "2026-08-10T15:50:46.041Z",
  "ReviewedTime": "2026-08-10T15:50:46.041Z"
}

Upload files (with content)

post

Uploads one or more files to temporary storage for authenticated users or valid survey response sessions.

Query parameters

responseIdstringOptional

Optional survey response identifier for unauthenticated respondents

Responses

200

OK

No content

post/api/assets/files/temp

HTTPcURLJavaScriptPython

POST /v2/e01/api/assets/files/temp HTTP/1.1
Accept: */*

200

OK

No content

Retrieve a file (content only)

get

Retrieves the content for a specific file using its unique ID and filename. Performs authorization checks and supports caching. It is important to note the caller must know the name of the file, in addition to its unique ID, or the server will return a 404 Not Found - even if the ID is valid.

Path parameters

idstring · uuidRequired

The unique identifier of the file to retrieve

namestringRequired

The expected filename for validation purposes

Query parameters

downloadstringOptional

Optional parameter: set to "1" to force download, otherwise file is displayed inline

Responses

200

OK

No content

get/api/assets/files/{id}/{name}

HTTPcURLJavaScriptPython

GET /v2/e01/api/assets/files/{id}/{name} HTTP/1.1
Accept: */*

200

OK

No content