Creates a new projecttemplate file for the projecttemplate with the specified id.. | awork API

curl -X POST https://api.awork.com/api/v1/projecttemplates/projecttemplateId/files \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: multipart/form-data" \
     -F File=@string

{
  "name": "Final project report",
  "description": "The client requested a cost overview and timeline",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "taskId": "123e4567-e89b-12d3-a456-426614174000",
  "taskTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "documentId": "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,
  "externalProvider": null,
  "externalFileUrl": null,
  "isHiddenForConnectUsers": true,
  "entityId": "123e4567-e89b-12d3-a456-426614174000"
}

Uploads a new projecttemplate file for the projecttemplate with the specified id. Use this to upload a file as a form value along with the basic file meta data. The file size must not exceed 1GB.

Required Permissions

Any authenticated user.

Uploads a new projecttemplate file for the projecttemplate with the specified id. Use this to upload a file as a form value along with the basic file meta data. The file size must not exceed 1GB. <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

projecttemplateIdstringRequiredformat: "uuid"

The id of the projecttemplate.

Request

This endpoint expects a multipart form containing a file.

FilefileRequired

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.

projectIdstring or nullformat: "uuid"

projectTemplateIdstring or nullformat: "uuid"

companyIdstring or nullformat: "uuid"

taskIdstring or nullformat: "uuid"

taskTemplateIdstring or nullformat: "uuid"

userIdstring or nullformat: "uuid"

documentIdstring or nullformat: "uuid"

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.

createdOnstringformat: "date-time"

The date this file was created.

createdBystringformat: "uuid"

The id of the user who created this file.

updatedOnstringformat: "date-time"

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.

entityIdstring or nullformat: "uuid"Deprecated

Deprecated. The id of the linked entity derived from entity specific owner ids.

Errors

400

Bad Request Error