Documentation Powered by ReDoc

Infinite Proxy (1.0.0)

Download OpenAPI specification:Download

E-mail: support@realfusio.com License: Close Source

Infinite Proxy api

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Infinite_Data_Api_Key

an api key allowing 'admin' access on a proxy

Security Scheme Type API Key
Header parameter name: x-infinite-apikey

Infinite_Directory_Admin

a directory session bearer with access rights to the frontend

Security Scheme Type API Key
Header parameter name: x-infinite-bearer

Infinite_Directory_Admin_On_Query

a directory session bearer with access rights to the frontend

Security Scheme Type API Key
Query parameter name: x-infinite-bearer

/build/{buildid}/evojuump

Removes evojuump or cancel creation (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
buildid
required
string 38 characters ^\{[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-...

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/build/{buildid}/evojuump

Downloads evojuump (only available on generator)

Authorizations:
Infinite_Data_Api_KeyInfinite_Directory_AdminInfinite_Directory_Admin_On_Query
path Parameters
buildid
required
string 38 characters ^\{[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-...

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/build/{buildid}/evojuump

Request evojuump creation (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
buildid
required
string 38 characters ^\{[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-...
header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8
evojuumppassword
required
string

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "evojuumppassword": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/generatebuildresult

Returns list of build generation results

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
query Parameters
projectid
string 36 characters ^prj_[a-f0-9]{32}$
Example: projectid=prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

buildid
string 38 characters ^\{[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-...
onlynotacknowledged
boolean
Default: true
onlyfailed
boolean
Default: true
limit
integer [ 1 .. 128 ]
Default: 1

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

/getcapabilities

Allows an executable or automated script to retrieve programmatically basic information regarding the hardware capabilities of an Infinite Server

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "cpu_count": 0,
  • "ram_quantity_bytes": 0
}

/project/{projectid}

delete a project (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

query Parameters
removebuilds
boolean

should we also remove builds

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}

Returns project properties (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "compressionlevel": "Lzma",
  • "generatorversion": "string",
  • "normalformat": "xy16",
  • "projectcomment": "My Project",
  • "projectid": "prj_091d232caeae2c0d2e4e63b031534c5b",
  • "sourcemodelmirrorversion": "string",
  • "unit": "millimeter"
}

/project/{projectid}

Creates a project, this operations is asynchronous and could take time (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

header Parameters
content-length
required
integer <= 1048576

json body is limited to 1MB

Request Body schema: application/json; charset=utf-8
compressionlevel
required
string
Enum: "Lzma" "Zip" "Raw"

the compression algorithm to use

normalformat
required
string
Enum: "xy16" "xyz16" "xy32" "xyz32"

the method used to store normals

projectcomment
required
string non-empty

the human readable name of the project

unit
required
string
Enum: "millimeter" "centimeter" "decimeter" "meter" "inch"

the unit of the project

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "compressionlevel": "Lzma",
  • "normalformat": "xy16",
  • "projectcomment": "My Project",
  • "unit": "millimeter"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/ackbuilderror

Acknowledge current build generation errors (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/build/{buildid}/generationreport

returns generation report of the build if available

Authorizations:
Infinite_Data_Api_KeyInfinite_Directory_AdminInfinite_Directory_Admin_On_Query
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

buildid
required
string 38 characters ^\{[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-...
query Parameters
file
string
Default: "all"
Enum: "all" "jsonstats" "htmlreport"

which file to retrieve

Responses

Response samples

Content type
application/json; charset=utf-8
application/json; charset=utf-8
application/zip
text/html; charset=utf-8
{ }

/project/{projectid}/cleargenerationdata

Cancels clear of generation data (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/cleargenerationdata

Requests generation data clear to reclaim storage space (only available on generator), this will remove files pulled by sourcers of pushed through /pushfile api

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

query Parameters
before
required
integer >= 1

generation data older than this epoch date will be removed

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/generatebuild

Cancels a build generation request (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/generatebuild

Sends a build generation request (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

query Parameters
buildparametersdocid
string non-empty
Default: "com.3djuump:buildparameters"

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/pushfile

Bacthes head request on a group of files

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

header Parameters
content-length
required
integer <= 16777216

json body is limited to 16MB

Request Body schema: application/json
Array ()
string^[a-z0-9{}\-_]+\.[a-z0-9]+$

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json; charset=utf-8
{
  • "property1": true,
  • "property2": true
}

/project/{projectid}/pushfile

Pushes files to a project id folder, those files could be referenced on a FileSystemSourcer using $LOCAL$ as baseurl each part should have a file name containing only that matches following regexp '^[a-z0-9{}-]+.[a-z0-9]'

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Request Body schema: multipart/form-data
geometry
string <binary>

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/pushfile/{pushfilename}

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

pushfilename
required
string^[a-z0-9{}\-_]+\.[a-z0-9]+$

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/pushfile/{pushfilename}

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

pushfilename
required
string^[a-z0-9{}\-_]+\.[a-z0-9]+$

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/pushfile/{pushfilename}

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

pushfilename
required
string^[a-z0-9{}\-_]+\.[a-z0-9]+$
Request Body schema: application/octet-stream
string <binary> non-empty

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/status

To coordinate the work between the connector and the Infinite Server, projects rely on a semaphore mechanism (see the Control Interface chapter of the Integration Manual). This route may be used by executables or automated scripts (e.g. the connector) to check the status of the corresponding project.

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "projectstatus": "string",
  • "projectstatusts": "string"
}

/project/{projectid}/status

To coordinate the work between the connector and the Infinite Server, projects rely on a semaphore mechanism (see the Control Interface chapter of the Integration Manual). This route may be used by executables or automated scripts (e.g. the connector) to update the status of the corresponding project.

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

query Parameters
projectstatus
required
string

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "ok": true,
  • "projectstatus": "string"
}

/project/{projectid}/syncmetadata

Cancels metadata synchronization (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}

/project/{projectid}/syncmetadata

Requests metadata synchronization from the connector index (only available on generator)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Directory_Admin
path Parameters
projectid
required
string 36 characters ^prj_[a-f0-9]{32}$
Example: prj_091d232caeae2c0d2e4e63b031534c5b

the unique identifier of the project

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "code": "E_UnknownError",
  • "error": true,
  • "uuid": "string"
}