Documentation Powered by ReDoc

Altair SLC Hub Published Library Datasets Client (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

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

queryPublishedLibraries

Authorizations:
bearerAuth
query Parameters
filter[namespace][EQ]
string
filter[namespace][IN]
Array of strings
filter[name][EQ]
string
filter[name][CO]
string
filter[name][ST]
string
page[offset]
integer
page[limit]
integer
sort
string
Enum: "name" "-name"

Responses

Response samples

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

getPublishedLibrary

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

Responses

Response samples

Content type
application/json
{
  • "libraryDefinitionId": "string",
  • "name": "string",
  • "namespace": "string",
  • "executionProfileId": "string"
}

queryLibraryMembers

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

query Parameters
filter[name][EQ]
string
filter[name][CO]
string
filter[name][ST]
string
filter[type][EQ]
string (memberType)
Enum: "DATA" "VIEW" "CATALOG"
filter[type][IN]
Array of strings (memberType)
Items Enum: "DATA" "VIEW" "CATALOG"
page[offset]
integer
page[limit]
integer
sort
string
Enum: "name" "-name" "type" "-type"

Responses

Response samples

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

getDatasetMetadata

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

name
required
string

The name of the dataset

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "engine": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "nobs": 0,
  • "compressionType": "string",
  • "type": "string",
  • "charEncoding": "string",
  • "isPointobs": true,
  • "dataRepresentation": "string",
  • "recordLength": 0,
  • "engineProperties": [
    ],
  • "sort": [
    ],
  • "sortOptions": {
    },
  • "indexes": [
    ],
  • "fields": [
    ]
}

getRecords

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

name
required
string

The name of the dataset

query Parameters
limit
integer

The maximum number of observations to return. If not specified, defaults to 1000

offset
integer

The number of observations at the beginning of the data set to skip. That is, this is consistent with removing the first offset records from the result of requesting GET /datasets/{id}/records with no offset query parameter.

filter
string

A filter to apply to the dataset in the form of a where clause expression.

fields
Array of strings

The list of fields to return

orderby
Array of strings

The order in which the records should be returned. Each entry should be the name of a field. Optionally the field name can be specified with a leading '-' to indicate that the field should be ordered in reverse order.

formatted
Array of strings

The list of fields for which formatted values should be returned. The value all can be used to return formatted values for all fields.

allowAsync
boolean

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ],
  • "values": [
    ]
}

validateFilter

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

name
required
string

The name of the dataset

Request Body schema: text/plain
string

Responses

Response samples

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

getDistinctValues

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

name
required
string

The name of the dataset

query Parameters
timeout
integer

The maximum time in seconds to take performing the calculation

maxValues
integer

The maximum number of values to return for any field

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

getServerStatus

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

Responses

Response samples

Content type
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "poolSize": 0,
  • "failedWorkerCount": 0,
  • "workers": {
    },
  • "description": {
    }
}

restartWorker

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

worker-index
required
integer

The index of the worker

Responses

listAsyncOperations

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

deleteAsyncOperation

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

operationId
required
string

The unique id of the async operation

Responses

Response samples

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

getAsyncOperationStatus

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

operationId
required
string

The unique id of the async operation

Responses

Response samples

Content type
application/json
{
  • "state": "queued",
  • "reapTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "error": {
    },
  • "method": "string",
  • "parameters": { }
}

getAsyncOperationResult

Authorizations:
bearerAuth
path Parameters
id
required
string

The id of the library

operationId
required
string

The unique id of the async operation

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ],
  • "values": [
    ]
}