API Methods - Project

The API methods that can be used with the RSNode to affect the project.

getProjectCleartags

Clear a tag or all of them from a project.

GET
/project/cleartags

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
tag String
Tag name		 Optional

Responses

Schema:

boolean
 Cleared tags

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectCleartasks

Clear the task information.

GET
/project/cleartasks

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
taskIds array[UUID] (uuid)
Task identifiers		 Optional

Responses

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectClose

Close the project and free the allocated resources associated with the project.

GET
/project/closes

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Responses

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectCommand

Send a CLI command.

GET
/project/command

Examples:

/project/command?name=align
/project/command?name=calculateHighModel
/project/command?name=calculateNormalModel
/project/command?name=simplify
/project/command?name=exportModel&param1=Model%201&param2=model_name.obj
/project/command?name=exportSelectedModel&param1=model_name.obj

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
name* String
Command name		 Required
param1 String
Command parameter		 Optional
param2 String
Command parameter		 Optional
param3 String
Command parameter		 Optional
param4 String
Command parameter		 Optional
param5 String
Command parameter		 Optional
param6 String
Command parameter		 Optional
param7 String
Command parameter		 Optional
param8 String
Command parameter		 Optional
param9 String
Command parameter		 Optional

Responses

Schema:

Task Handle {
 taskID: string (uuid)
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectCondcommand

Send a conditional CLI command. If the tag is not send, a CLI command will be sent.

GET
/project/condcommand

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
tag* String
Tag name		 Required
name* String
Command name		 Required
param1 String
Command parameter		 Optional
param2 String
Command parameter		 Optional
param3 String
Command parameter		 Optional
param4 String
Command parameter		 Optional
param5 String
Command parameter		 Optional
param6 String
Command parameter		 Optional
param7 String
Command parameter		 Optional
param8 String
Command parameter		 Optional
param9 String
Command parameter		 Optional

Responses

Schema:

Task Handle {
 taskID: string (uuid)
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectCreate

Create a new project.

GET
/project/create

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required

Responses

Headers:

Name Type Format Description
Session UUID uuid Session Identifier

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectDelete

Delete a project.

GET
/project/delete

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required

Query parameters

Name Description Necessity
guid* String
Project guid		 Required

Responses

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectDisconnect

Disconnect a user from the session. The session will automatically terminate once it has no more CLI commands to run.

GET
/project/disconnect

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Caller application identifier		 Required

Responses

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectDownload

Download the session output file.

GET
/project/download

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Caller application identifier		 Required

Query parameters

Name Description Necessity
name* String
File name or wildcard filter		 Required
folder String
Specify the folder to look at (output by default)		 Optional
mode String
Set to zip to download multiple files at once		 Optional

Responses

Schema:

string (binary)

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectList

Return a list of the opened project files.

GET
/project/list

Parameters

Header parameters

Name Description Necessity
Session* UUID (uuid)
Caller application identifier		 Required

Query parameters

Name Description Necessity
folder String
Specify the folder to look at (output by default)		 Optional

Responses

Schema:

[string]

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectOpen

Open an existing project.

GET
/project/open

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required

Query parameters

Name Description Necessity
guid* String
Project Guid		 Required
name String
Scene name		 Optional

Responses

Headers:

Name Type Format Description
Session UUID uuid Session Identifier

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectSave

Save a project to the local file system.

GET
/project/save

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
name String
Scene name		 Optional

Responses

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectStatus

Get the project status.

GET
/project/status

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Responses

Schema:

RS Project Status {
 restarted: boolean
    RS instance for this session has been automatically restarted after unexpected termination
 progress: number
    Estimated progress
 timeTotal: number
    Time spent
 timeEstimation: number
    Estimated finnish time
 errorCode: integer
    Error code encountered
 changeCounter: integer
    Change counter
 processID: integer
    Instance process ID
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectTags

Lists all existing tags.

GET
/project/tags

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Responses

Schema:

[string]
   Tag names

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectTasks

Lists all tasks.

GET
/project/tasks

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
taskIDs array[UUID] (uuid)
Task identifiers		 Optional

Responses

Schema:

[
 Task Status {
  taskID: string (uuid)
  timeStart: integer (date-time)
     Unix time (milliseconds) in UTC when the task started
  timeEnd: integer (date-time)
     Unix time (milliseconds) in UTC when the task ended
  state: string
     Execution state of the task, one of {"scheduled", "started", "finished", "failed"}
  errorCode: integer
     Error code encountered
  errorMessage: string
     Error message encountered
 }
]

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

getProjectTesttag

Test if a project tag exists.

GET
/project/testtag

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
tag* String
Tag name		 Required

Responses

Schema:

boolean
   Tag exists

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

postProjectAcknowledgeRestart

Acknowledge that the RealityScan instance for this session has been restarted (reset restarted state to false).

POST
/project/acknowledgerestart

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Responses

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

postProjectCommand

Send a CLI command with the POST data.

POST
/project/command

Examples:

/project/command?name=add&param1=image_name.jpg
/project/command?name=simplify&param1=simplification_config.xml
/project/command?name=exportReport&param1=report.txt&param2=template.txt
/project/command?name=exportSelectedModel&param1=model_name.obj&param2=export_config.xml

For multiple inputs use /project/upload with folder=output to upload multiple files, then use GET /project/command.

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
name* String
Command name		 Required
param1 String
Command parameter		 Optional
param2 String
Command parameter		 Optional
param3 String
Command parameter		 Optional
param4 String
Command parameter		 Optional
param5 String
Command parameter		 Optional
param6 String
Command parameter		 Optional
param7 String
Command parameter		 Optional
param8 String
Command parameter		 Optional
param9 String
Command parameter		 Optional
encoded String
Set to "base64" for base64 encoded data (raw by default)		 Optional

Responses

Schema:

Task Handle {
 taskID: string (uuid)
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

postProjectCommandGroup

Send multiple CLI commands as a group with the POST data. This group stops execution if any of the commands fail, and sets the task error code to the corresponding error value.

POST
/project/commandgroup

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Body parameters

Name Description Necessity
commandCall * [undefined]
The token request body		 Optional

Responses

Schema:

Task Handle {
 taskID: string (uuid)
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

postProjectCondcommand

Send a conditional CLI command. If the tag is not set, a CLI command will be sent.

POST
/project/condcommand

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
tag* String
Tag name		 Required
name* String
Command name		 Required
param1 String
Command parameter		 Optional
param2 String
Command parameter		 Optional
param3 String
Command parameter		 Optional
param4 String
Command parameter		 Optional
param5 String
Command parameter		 Optional
param6 String
Command parameter		 Optional
param7 String
Command parameter		 Optional
param8 String
Command parameter		 Optional
param9 String
Command parameter		 Optional
encoded String
Set to "base64" for base64 encoded data (raw by default)		 Optional

Responses

Schema:

Task Handle {
 taskID: string (uuid)
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

postProjectCommandGroup

Execute multiple conditioned CLI commands as a group if the tag is not set.

POST
/project/condcommandgroup

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
tag* String
Tag name		 Required

Responses

Schema:

Task Handle {
 taskID: string (uuid)
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

postProjectUpload

Upload a single project file.

POST
/project/upload

Parameters

Header parameters

Name Description Necessity
clientId* UUID (uuid)
Client identifier		 Required
appToken* String
Caller application identifier		 Required
Session* UUID (uuid)
Session identifier		 Required

Query parameters

Name Description Necessity
name* String
File name		 Required
encoded String
Set to "base64" for base64 encoded data (raw by default)		 Optional
folder String
Specify a folder to upload to		 Optional

Responses

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

Schema:

apiError {
 code: integer
 message: string
}

API Methods - Node

The API methods affecting the node