Return instance file metadata.

GET

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

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"),
    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';
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 \
  --header 'Authorization: Bearer <token>'

Returns file-reference metadata 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

application/json

object

Data

required

Any of:

object
object

object

required

string

FolderId

required

string

Owner

object

ModuleKey

required

string

ResourceKind

required

string

ContextResourceId

required

string

ResourceObjectId

required

string

Relations

required

Array<object>

Stored relation between one content item and a target resource.

object

string

nullable

Target

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

Relation kind between content and a resource.

integer format: int32

Allowed values: 0

Source

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

Any of:

object
object

Stored technical origin metadata for content created through another resource context.

object

Source

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

IsDeleted

required

boolean

EditDeadline

required

string format: date-time

RowVersion

required

string format: uuid

Descriptor

required

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

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

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

application/json

object

Data

required

Any of:

object
object

object

required

string

FolderId

required

string

Owner

object

ModuleKey

required

string

ResourceKind

required

string

ContextResourceId

required

string

ResourceObjectId

required

string

Relations

required

Array<object>

Stored relation between one content item and a target resource.

object

string

nullable

Target

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

Relation kind between content and a resource.

integer format: int32

Allowed values: 0

Source

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

Any of:

object
object

Stored technical origin metadata for content created through another resource context.

object

Source

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

IsDeleted

required

boolean

EditDeadline

required

string format: date-time

RowVersion

required

string format: uuid

Descriptor

required

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

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

required

string

FolderId

required

string

Owner

object

ModuleKey

required

string

ResourceKind

required

string

ContextResourceId

required

string

ResourceObjectId

required

string

Relations

required

Array<object>

Stored relation between one content item and a target resource.

object

string

nullable

Target

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

Relation kind between content and a resource.

integer format: int32

Allowed values: 0

Source

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

Any of:

object
object

Stored technical origin metadata for content created through another resource context.

object

Source

Stable identity of one Moltaro resource instance.

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

IsDeleted

required

boolean

EditDeadline

required

string format: date-time

RowVersion

required

string format: uuid

Descriptor

required

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

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
    }
  ]
}

Return instance file metadata.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

403

Examplegenerated

404

Example

409

Example

Example^generated