Add file to project

POST 
/projects/:projectId/files

Require admin rights

Request

Path Parameters

projectId stringrequired

application/json

Body

name stringrequired
uploadId stringnullable
wms stringnullable
wcs stringnullable
folderId stringnullable
path string[]nullable
position double[]nullable
Example: [0,0,0]
rotation double[]nullable
Quaternion rotation
Example: [0,0,0,1]
scale double[]nullable
Example: [1,1,1]

tags

object[]

nullable

Array [

id stringrequired

Tag.

Example: status

name stringnullable

Tag value.

Example: approved

]

Responses

201

File successfuly added to project

application/json

Schema

Schema

id stringrequired
name stringrequired
source stringrequired
wms stringnullable
wcs stringnullable
lastUpdatedBy stringrequired
lastUpdatedAt date-timerequired
resourceId stringrequired
position double[]nullable
Example: [0,0,0]
rotation double[]nullable
Quaternion rotation
Example: [0,0,0,1]
scale double[]nullable
Example: [1,1,1]
uploadId stringrequired
version int32required
size int64
error stringnullable

tags

object[]

nullable

Array [

id stringrequired

Tag.

Example: status

name stringnullable

Tag value.

Example: approved

]

state State (string)

Possible values: [skip, converting, conversion_failed, pending, in_scene]

deleted booleannullable

types

object[]

nullable

Array [

type stringrequired

size int64required

]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "source": "string",
  "wms": "string",
  "wcs": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedAt": "2024-07-29T15:51:28.071Z",
  "resourceId": "string",
  "position": [
    0,
    0,
    0
  ],
  "rotation": [
    0,
    0,
    0,
    1
  ],
  "scale": [
    1,
    1,
    1
  ],
  "uploadId": "string",
  "version": 0,
  "size": 0,
  "error": "string",
  "tags": [
    {
      "id": "status",
      "name": "approved"
    }
  ],
  "state": "skip",
  "deleted": true,
  "types": [
    {
      "type": "string",
      "size": 0
    }
  ]
}

202

File already exists

application/json

Schema

Schema

id stringrequired
name stringrequired
source stringrequired
wms stringnullable
wcs stringnullable
lastUpdatedBy stringrequired
lastUpdatedAt date-timerequired
resourceId stringrequired
position double[]nullable
Example: [0,0,0]
rotation double[]nullable
Quaternion rotation
Example: [0,0,0,1]
scale double[]nullable
Example: [1,1,1]
uploadId stringrequired
version int32required
size int64
error stringnullable

tags

object[]

nullable

Array [

id stringrequired

Tag.

Example: status

name stringnullable

Tag value.

Example: approved

]

state State (string)

Possible values: [skip, converting, conversion_failed, pending, in_scene]

deleted booleannullable

types

object[]

nullable

Array [

type stringrequired

size int64required

]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "source": "string",
  "wms": "string",
  "wcs": "string",
  "lastUpdatedBy": "string",
  "lastUpdatedAt": "2024-07-29T15:51:28.071Z",
  "resourceId": "string",
  "position": [
    0,
    0,
    0
  ],
  "rotation": [
    0,
    0,
    0,
    1
  ],
  "scale": [
    1,
    1,
    1
  ],
  "uploadId": "string",
  "version": 0,
  "size": 0,
  "error": "string",
  "tags": [
    {
      "id": "status",
      "name": "approved"
    }
  ],
  "state": "skip",
  "deleted": true,
  "types": [
    {
      "type": "string",
      "size": 0
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

any

401

Unauthorized

404

Not Found

500

Server Error

Loading...