Documentation Powered by ReDoc

Infinite assets api (1.0.0)

Download OpenAPI specification:Download

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

Infinite assets 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_Data_Project

a data session bearer associated to a specific project

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

Infinite_Data_Project_Asset_Admin

a data session bearer associated to a specific project information with asset admin rights

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

/{projectid}

Removes an asset database for a project

Authorizations:
BasicInfinite_Data_Api_Key
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"
}

/{projectid}

gets the backup of the full project

Authorizations:
BasicInfinite_Data_Api_Key
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/x-ndjson; charset=utf-8
"string"

/{projectid}

Restores the backup of the full project (upsert), documents already in the dabase and not upserted are kept

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

the unique identifier of the project

Request Body schema: application/x-ndjson
string <binary>

Responses

Request samples

Content type
application/x-ndjson
"string"

Response samples

Content type
application/json; charset=utf-8
{
  • "documents": {
    },
  • "errors": true,
  • "items": [
    ],
  • "syntaxerrors": 0,
  • "took": 0
}

/{projectid}

Creates an asset database for a project

Authorizations:
BasicInfinite_Data_Api_Key
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"
}

/{projectid}/docs

Gets a list of documents from their id and optionaly revisions

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Data_Project_Asset_AdminInfinite_Data_Project
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
required
Array of objects

Responses

Request samples

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

Response samples

Content type
application/x-ndjson; charset=utf-8
"string"

/{projectid}/docs

Commits a batch of documents

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

the unique identifier of the project

Request Body schema: application/x-ndjson
string <binary>

Responses

Request samples

Content type
application/x-ndjson
"string"

Response samples

Content type
application/json; charset=utf-8
{
  • "documents": {
    },
  • "errors": true,
  • "items": [
    ],
  • "syntaxerrors": 0,
  • "took": 0
}

/{projectid}/docs/delete

Removes a list of documents from their id and revisions

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Data_Project_Asset_AdminInfinite_Data_Project
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
required
Array of objects

Responses

Request samples

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

Response samples

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

/{projectid}/revisions

Gets a list of revisions of documents from their id

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Data_Project_Asset_AdminInfinite_Data_Project
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
assets
required
Array of strings

Responses

Request samples

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

Response samples

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

/{projectid}/search

Searches for documents that matches a list of criteria

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Data_Project_Asset_AdminInfinite_Data_Project
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
adminmode
required
boolean
all
required
string
apptype
required
Array of strings
description
required
string
excludedassetid
required
string^(?:[A-Za-z0-9+\-]{22})?$
maxhits
required
integer >= 1
modificationusers
required
Array of strings
name
required
string
nameexact
required
string
required
Array of objects
tags
required
Array of strings
teams
required
Array of strings

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "adminmode": true,
  • "all": "string",
  • "apptype": [
    ],
  • "description": "string",
  • "excludedassetid": "string",
  • "maxhits": 1,
  • "modificationusers": [
    ],
  • "name": "string",
  • "nameexact": "string",
  • "searchorder": [
    ],
  • "tags": [
    ],
  • "teams": [
    ]
}

Response samples

Content type
application/x-ndjson; charset=utf-8
"string"

/{projectid}/stats

Gets the list of tags, modification users, creation users in relation to the given user (i.e. that have access to the same assets)

Authorizations:
BasicInfinite_Data_Api_KeyBearerInfinite_Data_Project_Asset_AdminInfinite_Data_Project
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
adminmode
required
boolean
stats
required
Array of strings
Items Enum: "tags" "creationusers" "modificationusers"

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "adminmode": true,
  • "stats": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "creationusers": [
    ],
  • "modificationusers": [
    ],
  • "tags": [
    ]
}