Download instance file.

GET

/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/files/{fileId}/download

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/instances/example/files/example/download"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/entity/example/instances/example/files/example/download';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/workspace/entity/example/instances/example/files/example/download \
  --header 'Authorization: Bearer <token>'

Downloads file content for a file that is reachable through the readable fields of one entity instance. This endpoint follows record-surface access rules instead of direct folder visibility.

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

instanceId

required

string

fileId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

File bytes using the verified MIME type, or JSON direct-download authorization identified by X-Moltaro-Download-Authorization: 1. Do not forward the workspace token to storage.

string format: binary

object

Data

required

Any of:

object
object

object

DownloadUrl

required

string format: uri

DataPlaneOrigin

required

string format: uri

ExpiresAtUtc

required

string format: date-time

FileName

required

string

MimeType

required

string

FileSizeBytes

required

integer format: int64

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Headers

X-Moltaro-Download-Authorization

string

Allowed values: 1

Present with value 1 only for a JSON download authorization. Its absence identifies the file byte response.

206

Partial file bytes for an accepted Range request.

*/*

string format: binary

400

The operation was refused; inspect Errors. Data may be null.

application/json

object

Data

required

Any of:

object
object

object

Descriptor

object

required

string

FileName

required

string

Description

string

nullable

MimeType

required

string

StorageType

required

integer format: int32

Allowed values: 0 1 2 3 4 5

AvailabilityState

required

integer format: int32

Allowed values: 0 1 2 3 4

DetectedMimeType

string

nullable

ImageWidth

integer format: int32

nullable

ImageHeight

integer format: int32

nullable

ContentGeneration

required

integer format: int64

InspectedChecksumSha256

string

nullable

InspectedContentGeneration

integer format: int64

nullable

SizeBytes

required

integer format: int64

ChecksumSha256

required

string

CreatedAt

required

string format: date-time

ModifiedAt

string format: date-time

nullable

CreatedByUserId

string

nullable

CreatedByUserName

string

nullable

ModifiedByUserId

string

nullable

ModifiedByUserName

string

nullable

Content

string format: binary

nullable

RedirectUrl

string format: uri

nullable

RedirectExpiresAtUtc

string format: date-time

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden; the controller returns no response body.

404

Not Found

application/json

object

Data

required

Any of:

object
object

object

Descriptor

object

required

string

FileName

required

string

Description

string

nullable

MimeType

required

string

StorageType

required

integer format: int32

Allowed values: 0 1 2 3 4 5

AvailabilityState

required

integer format: int32

Allowed values: 0 1 2 3 4

DetectedMimeType

string

nullable

ImageWidth

integer format: int32

nullable

ImageHeight

integer format: int32

nullable

ContentGeneration

required

integer format: int64

InspectedChecksumSha256

string

nullable

InspectedContentGeneration

integer format: int64

nullable

SizeBytes

required

integer format: int64

ChecksumSha256

required

string

CreatedAt

required

string format: date-time

ModifiedAt

string format: date-time

nullable

CreatedByUserId

string

nullable

CreatedByUserName

string

nullable

ModifiedByUserId

string

nullable

ModifiedByUserName

string

nullable

Content

string format: binary

nullable

RedirectUrl

string format: uri

nullable

RedirectExpiresAtUtc

string format: date-time

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

required

Any of:

object
object

object

Descriptor

object

required

string

FileName

required

string

Description

string

nullable

MimeType

required

string

StorageType

required

integer format: int32

Allowed values: 0 1 2 3 4 5

AvailabilityState

required

integer format: int32

Allowed values: 0 1 2 3 4

DetectedMimeType

string

nullable

ImageWidth

integer format: int32

nullable

ImageHeight

integer format: int32

nullable

ContentGeneration

required

integer format: int64

InspectedChecksumSha256

string

nullable

InspectedContentGeneration

integer format: int64

nullable

SizeBytes

required

integer format: int64

ChecksumSha256

required

string

CreatedAt

required

string format: date-time

ModifiedAt

string format: date-time

nullable

CreatedByUserId

string

nullable

CreatedByUserName

string

nullable

ModifiedByUserId

string

nullable

ModifiedByUserName

string

nullable

Content

string format: binary

nullable

RedirectUrl

string format: uri

nullable

RedirectExpiresAtUtc

string format: date-time

nullable

Errors

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

required

Array<object>

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

required

boolean

Example

{
  "Data": null,
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}