File Resources

File Resources are objects in Limecraft Flow that can be used to store (small) files. They are typically used for storing files needed during any workflow or in the settings such as watermarks.

File Resources can be created both on a production and on an account level. For the remainder of this collection, we will use production file resources, but the same calls are equally valid for the accounts, simply by replacing the production/{productionId} part of the url with account/{accountId}.

List the file resources

GET /production/{prId}/file

This call lists all the file resources within the production.

Details
Description

It will return a list of all existing file resources.

Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Return Type

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Content Type

  • application/json

Responses
Table 1. http response codes
Code Description Datatype

200

The request was successful.

FileResource

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production was not found.

NotFoundError

As for all listing calls, paging is supported.

Filter the response

File Resources can be queried by means of filter query parameters of which the following are currently supported:

Query parameter Description Example

deleted

filter file resources by flag deleted (true/false)

/api/production/123/file?fq=deleted:false

deletedTimestamp

filter file resources by property deletedTimestamp

api/production/123/file?fq=deletedTimestamp:[2013-07-17T00:00:00Z TO 2023-07-17T00:00:00Z]

shouldBeOnBackup

filter file resources by flag shouldBeOnBackup

/api/production/123/file?fq=shouldBeOnBackup:false

onFlow

filter file resources by flag onFlow

/api/production/123/file?fq=onFlow:true

onBackup

filter file resources by flag onBackup

/api/production/123/file?fq=onBackup:false

shouldBeOnFlow

filter file resources by flag shouldBeOnFlow

/api/production/123/file?fq=shouldBeOnFlow:true

shouldBeOnBackupTimestamp

filter file resources by flag shouldBeOnBackupTimestamp

/api/production/123/file?fq=shouldBeOnFlow:true

shouldBeOnFlowTimestamp

filter file resources by property shouldBeOnFlowTimestamp

/api/production/123/file?fq=shouldBeOnFlow:true

onBackupTimestamp

filter file resources by property onFlowTimestamp

/api/production/123/file?fq=onBackupTimestamp:[2013-07-17T00:00:00Z TO 2023-07-17T00:00:00Z]

onFlowTimestamp

filter file resources by property onFlowTimestamp

/api/production/123/file?fq=onFlowTimestamp:[2013-07-17T00:00:00Z TO 2023-07-17T00:00:00Z]

location

filter file resources by property location

/api/production/123/file?fq=location:1/123/export/reportFileResource.csv

filename

filter file resources by property filename

/api/production/123/file?fq=location:reportFileResource.csv

funnel

filter file resources by property funnel

/api/production/123/file?fq=funnel:export

mimeType

filter file resources by property mimeType

/api/production/123/file?fq=mimeType:application/text

pattern

filter file resources by pattern

transferDetails

filter file resources by transferDetails, json query supported

customFields

filter file resources by customFields, json query supported

systemFields

filter file resources by systemFields, json query supported

md5VerificationStatus

filter file resources by md5VerificationStatus

/api/production/123/file?fq=md5VerificationStatus:NOT_VERIFIED

account

filter file resources by accountId

/api/production/123/file?fq=account:123

production

filter file resources by productionId

/api/production/123/file?fq=production:123

editorialObject

filter file resources by editorialObjectId

/api/production/123/file?fq=editorialObject:123

Call example

/api/production/12345/file?fq=funnel:TempFile&fq=mimeType:video/mp4

Create new file resource

POST /production/{prId}/file

This call creates a file resource.

Details
Description
Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long
Body Parameters
Name Description Required Type

FileResourceRequest

FileResource object.

✘

FileResourceRequest

FileResourceRequest

Field Name Required Type Description Format

accessToken

✘

String

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

fileName

✘

String

filename

✘

String

fingerprints

✘

Set of string

forceOverwrite

✘

Boolean

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

prefix

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Return Type

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Content Type

  • application/json

Responses
Table 2. http response codes
Code Description Datatype

201

The request was successful.

FileResource

403

The user needs PRODUCTION_MANAGE rights.

ForbiddenError

404

The production was not found.

NotFoundError

Body example

{
    "FileResourceRequest": {
        "funnel": "Documentation",
        "filename": "1.mp4",
        "customFields": {
            "MyCustomField": {
                "value": "MyValue",
                "label": "My Custom Field"
            }
        },
        "expireTimestamp": 1581005167994,
        "mimeType": "video/mp4"
    }
}

Update existing file resource

PUT /production/{prId}/file/{id}

This call updates file resources within the production.

Details
Description
Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the file resource.

✔

Long
Body Parameters
Name Description Required Type

FileResource

New, desired, file resource object.

✔

FileResource

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Return Type

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Content Type

  • application/json

Responses
Table 3. http response codes
Code Description Datatype

200

The request was successful.

FileResource

403

The user needs PRODUCTION_MANAGE rights.

ForbiddenError

404

The production was not found.

NotFoundError

409

The version in the update object does not match with the version stored causing an optimistic lock.

ConflictError

Body example

{
  "version": {{fileResourceVersion}},
  "customFields": {
    "MyCustomField": {
      "value": "MyValue",
      "label": "My Custom Field"
    }
  },
  "expireTimestamp": 1581005167994,
  "mimeType": "video/mp4",
  "funnel": "Documentation",
  "filename": "1.mp4"
}

Create a file resource upload

In a similar manner to the clip creation, you can also do the creation of a file resource.

It is a three-step procedure of creating the upload, sending the data itself, and closing the upload.

We will list the calls and examples below, but for a clearer overview of this procedure, you can see the section on clip upload.

POST /production/{prId}/file/{id}/upload

This call uploads the file resource.

Details
Description
Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the file resource.

✔

Long
Body Parameters
Name Description Required Type

FileResourceRequest

File resource to be uploaded.

✔

FileResourceRequest

FileResourceRequest

Field Name Required Type Description Format

accessToken

✘

String

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

fileName

✘

String

filename

✘

String

fingerprints

✘

Set of string

forceOverwrite

✘

Boolean

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

prefix

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Return Type

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Content Type

  • application/json

Responses
Table 4. http response codes
Code Description Datatype

200

The request was successful.

FileResource

402

There are not enough subscription resources available to complete this request.

QuotaExceededError

403

The user needs PRODUCTION_MANAGE rights.

ForbiddenError

404

The production or FileResource was not found.

NotFoundError

Body example

{
  "fileName": "test/resources/1.mp4",
  "size": 88952
}

Send data

It is a PUT call to the {uploadLocation}.

Close a file resource upload

POST /production/{prId}/file/{id}/close

This call finishes the upload of the file resource.

Details
Description
Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the file resource.

✔

Long
Query Parameters
Name Description Required Type

skipVerification

Skip verification parameter.

✘

Boolean
Return Type

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Content Type

  • application/json

Responses
Table 5. http response codes
Code Description Datatype

200

The request was successful.

FileResource

403

The user needs PRODUCTION_MANAGE rights.

ForbiddenError

404

The production or FileResource was not found.

NotFoundError

412

The upload was not complete.

PreconditionFailedError

Download a file resource

GET /production/{prId}/file/{id}/download

This call downloads the file resource.

Details
Description
Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the file resource.

✔

Long
Return Type

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Content Type

  • application/json

Responses
Table 6. http response codes
Code Description Datatype

200

The request was successful.

FileResource

403

The user needs PRODUCTION_VIEW rights.

ForbiddenError

404

The production or FileResource was not found.

NotFoundError

Delete a file resource

DELETE /production/{prId}/file/{id}

This call deletes file resource within the production.

Details
Description
Parameters
Path Parameters
Name Description Required Type

prId

ID of the production.

✔

Long

id

ID of the file resource.

✔

Long
Body Parameters
Name Description Required Type

DeleteRequest

Body of the DeleteRequest type.

✔

DeleteRequest

DeleteRequest

Field Name Required Type Description Format

force

✘

Boolean

hard

✘

Boolean
Return Type

FileResource

Field Name Required Type Description Format

accountId

✘

Long

int64

adminOnly

✘

Boolean

businessKey

✘

String

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

creatorId

✘

Long

The id of the user who created this resource

int64

customFields

✘

CustomFields

deleted

✘

Boolean

deletedTimestamp

✘

Date

date-time

editorialObjectId

✘

Long

int64

filename

✘

String

fingerprints

✘

Set of string

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

location

✘

String

md5

✘

String

md5Partials

✘

String

md5VerificationCompleted

✘

Date

date-time

md5VerificationStatus

✘

String

Enum: NOT_VERIFIED, VERIFIED, REJECTED,

mimeType

✘

String

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

onBackup

✘

Boolean

onBackupTimestamp

✘

Date

date-time

onFlow

✘

Boolean

onFlowTimestamp

✘

Date

date-time

pattern

✘

String

productionId

✘

Long

int64

removeFromQuota

✘

Boolean

requiredRights

✘

List of ProductionPermission

shouldBeOnBackup

✘

Boolean

shouldBeOnBackupTimestamp

✘

Date

date-time

shouldBeOnFlow

✘

Boolean

shouldBeOnFlowTimestamp

✘

Date

date-time

size

✘

Long

int64

systemFields

✘

CustomFields

transferDetails

✘

TransferDetails

uid

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64
Content Type

  • application/json

Responses
Table 7. http response codes
Code Description Datatype

200

The request was successful.

FileResource

403

The user needs PRODUCTION_MANAGE rights.

ForbiddenError

404

The production or FileResource was not found.

NotFoundError