Documentation Powered by ReDoc

Altair SLC Hub Namespaces (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

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

getDefaultNamespace

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "isDefault": true
}

queryNamespaces

Authorizations:
bearerAuth
query Parameters
filter[_id][EQ]
string
filter[_id][IN]
Array of strings
filter[name][EQ]
string
filter[name][CO]
string
filter[name][ST]
string
filter[_created][LT]
string <date-time>
filter[_created][GT]
string <date-time>
filter[_modified][LT]
string <date-time>
filter[_modified][GT]
string <date-time>
page[offset]
integer
page[limit]
integer
sort
string
Enum: "name" "-name" "_created" "-_created" "_modified" "-_modified"

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ]
}

createNamespace

Authorizations:
bearerAuth
Request Body schema: application/json
_id
string
_created
string <date-time>
_modified
string <date-time>
name
required
string
description
string
isDefault
boolean

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "isDefault": true
}

nameAvailability

Authorizations:
bearerAuth
query Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "result": true,
  • "reason": "invalid",
  • "msg": "string"
}

getNamespace

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "isDefault": true
}

deleteNamespace

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}

putNamespace

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
_id
string
_created
string <date-time>
_modified
string <date-time>
name
required
string
description
string
isDefault
boolean

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "isDefault": true
}

patchNamespace

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json-patch+json
Array ()
op
required
string
Enum: "add" "remove" "replace"

The operation to be performed

path
required
string

A JSON-Pointer

value
any

The value to be used within the operations.

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "isDefault": true
}

setDefaultNamespace

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}