MeshController

Overview

• Description

  • Mesh Object

  • JSON fields

  • CSV fields

• API Reference

• GET /

• POST /

• GET /:id

• PUT /:id (json)

• GET /:id/data

• GET /data

• POST / — DEPRECATED

Description

Path /v2/meshes

Handles all requests regarding mesh: creating, updating, deleting.

Mesh Object

An example for a mesh JSON object.

{ 
 "id":"usm:TVLowboard",
 "visibilityStatus":1,
 "externalIdentifier":"TVLowboard",
 "catalog":"usm",
 "created": "2016-04-11T14:34:14.000Z", 
 "updated": "2016-04-11T14:34:14.000Z", 
 "assetProcesings": [{<list of processings associated with this mesh>>}},
 "links": {"data": "/meshes/usm:TVLowboard/data"}
 }

JSON fields

• id

• visibilityStatus : possible values

  • 0 : SHOWN (visible everywhere)

  • 1 : SHOWN_IN_CMS (visible only in cms context)

  • 2 : ARCHIVED (hidden everywhere)

• externalIdentifier

• catalog

• created

• updated

• assetProcessings

• links

CSV fields

• mesh_id - externalId of the mesh

• visibilityStatus - possible values

  • 0 : SHOWN (visible everywhere)

  • 1 : SHOWN_IN_CMS (visible only in cms context)

  • 2 : ARCHIVED (hidden everywhere)

• asset_source - http link to mesh source file

API Reference

GET /

Generates: application/json

List of all materials matching the filter and visible to the Client

Query Parameters

Name	Type	Comment
catalog	Boolean	If true the textures are included as embedded json objects, default is false

Response (200 OK): Returns a list of Mesh Object.

POST / (json)

Accepts: application/json Generates: application/json

Creates a new mesh.

Response (201 CREATED): Mesh Object

GET /:id

Generates: application/json

Returns a specific mesh.

Response(200 OK): Mesh Object

PUT /:id (json)

Accepts: application/json Generates: application/json

Updates a specific mesh.

Body: Mesh Object

Response (200 OK): updated Mesh Object

GET /:id/data

Accepts: application/json Generates: application/json

Returns list of meshData for the given mesh id. If no format, all meshdata entries for the given id are returned.

Query Parameters

Name	Type	Comment
format	String	format of requested meshData
targetQuality	Integer	quality of requested meshData - default 0 - returns closest match

Response (200 OK): Returns a list of MeshData Object.

GET /data

Generates: application/json

List of all meshData matching the filter and visible to the Client

Query Parameters

Name	Type	Comment
meshId[]	List of strings	filters the result to the given mesh ids
format	String	format of requested meshData
targetQuality	Integer	quality of requested meshData - default 0 - returns closest match

Response (200 OK): Returns a list of MeshData Object.

POST / — DEPRECATED

use POST /meshes instead