Creates a file from an upload id. | awork API

curl -X POST https://api.awork.com/api/v1/tasktemplates/tasktemplateId/files/byuploadid \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "uploadId": "1a2b3c4d5e6f7g8h9i0j",
  "fileName": "Pitch.ppt"
}'

{
  "name": "Final project report",
  "description": "The client requested a cost overview and timeline",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "Final project report.xlsx",
  "entityType": "project",
  "mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "createdOn": "2024-01-15T09:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2024-01-15T09:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "fileVersions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fileInfoId": "123e4567-e89b-12d3-a456-426614174000",
      "version": 13,
      "size": 13590,
      "width": 1920,
      "height": 1200,
      "createdOn": "2024-01-15T09:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedOn": "2024-01-15T09:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "isCommentFile": false,
  "isHiddenForConnectUsers": true
}

After a file has been uploaded to an upload URL generated from the endpoint, this endpoint can be used to create a file tasktemplate from the uploaded file by providing the upload id.

Required Permissions

Any authenticated user.

After a file has been uploaded to an upload URL generated from the <see cref="T:Awork.Files.Service.Feature.FileUpload.Endpoints.PostGenerateUploadURL" /> endpoint, this endpoint can be used to create a file tasktemplate from the uploaded file by providing the upload id. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

tasktemplateIdstringRequiredformat: "uuid"

The id of the tasktemplate to attach the file to.

Request

The model describing the uploaded file metadata.

uploadIdstringRequired>=1 character

The id of the temporary container that the file will be uploaded to.

fileNamestringRequired>=1 character

The name of the file that will be uploaded.

descriptionstring or nullOptional

The description of the file.

Response

namestring or null

The user-specified name of the file.

descriptionstring or null

The description of the file.

idstringformat: "uuid"

The id of the file info.

entityIdstring or nullformat: "uuid"

The id of the linked entity.

fileNamestring or null

The name of the file.

entityTypestring or null

The name of the linked entity type.

mimeTypestring or null

The MIME type of the file.

createdOndatetime

The date this file was created.

createdBystringformat: "uuid"

The id of the user who created this file.

updatedOndatetime

The date this file was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this file.

fileVersionslist of objects or null

List of all versions.

isCommentFileboolean

Whether the file is related to a comment.

externalProviderstring or null

The external provider for the file. Like 'google' or 'onedrive'.

externalFileUrlstring or null

The file url of the external provider.

isHiddenForConnectUsersboolean

Whether the file is hidden for connect users.

Errors

404

Not Found Error