Sign in

v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
File upload

Upload a file to a workflow job

To upload a file to a workflow job it needs to be uploaded via the Upload file endpoint for modern stack. After completing the various steps described in the Upload file endpoint, the fileId retrieved from those steps is needed in this request to reference the file to the job. This file will be attached to the job only. Warning: Requires the JOBEDIT security role. Warning: Is only available for Files-Service portals.

post/api/workflow-jobs/{id}/upload

Path parameters

idstring required
Example:00000000-0000-0000-0000-000000000000

The id of a Job.

Request body

fileIdstring

Id of the file to be saved to the job (to be retrieved from Upload file endpoint)

namestring

Value to be used as filename

fileSizenumber

Size of the file in bytes

assetIdstring

Id of the parent asset if this file is a new version of an asset

Example request

{
  "fileId": "00000000-0000-0000-0000-000000000001",
  "name": "example-name.jpg",
  "fileSize": 50000,
  "assetId": "00000000-0000-0000-0000-000000000002"
}

Response

Successful response

mediaIdstring

Media ID of the uploaded file

Example response

{
  "mediaId": "00000000000000000000000000000000"
}