Altair SLC Hub Library Definitions (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

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

listLibraryEngines

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"aliases": ["string"
],
"product": "string",
"module": "string",
"since": "string",
"platforms": ["WIN"
],
"requiresLocation": true,
"optionGroups": {"property1": {"name": "string",
"description": "string",
"platforms": ["WIN"
]
},
"property2": {"name": "string",
"description": "string",
"platforms": ["WIN"
]
}
},
"options": {"property1": {"type": "string",
"group": "string",
"name": "string",
"arg_name": "string",
"aliases": ["string"
],
"platforms": ["WIN"
]
},
"property2": {"type": "string",
"group": "string",
"name": "string",
"arg_name": "string",
"aliases": ["string"
],
"platforms": ["WIN"
]
}
}
}
]

getLibraryEngine

Authorizations:

bearerAuth

path Parameters

name

required

string

Responses

Response samples

200
404

Content type

application/json

{"name": "string",
"aliases": ["string"
],
"product": "string",
"module": "string",
"since": "string",
"platforms": ["WIN"
],
"requiresLocation": true,
"optionGroups": {"property1": {"name": "string",
"description": "string",
"platforms": ["WIN"
]
},
"property2": {"name": "string",
"description": "string",
"platforms": ["WIN"
]
}
},
"options": {"property1": {"type": "string",
"group": "string",
"name": "string",
"arg_name": "string",
"aliases": ["string"
],
"platforms": ["WIN"
]
},
"property2": {"type": "string",
"group": "string",
"name": "string",
"arg_name": "string",
"aliases": ["string"
],
"platforms": ["WIN"
]
}
}
}

queryLibraryDefinitions

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
filter[published][EQ]	boolean
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" "namespace" "-namespace" "_created" "-_created" "_modified" "-_modified"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"engine": "string",
"location": "string",
"options": {"property1": null,
"property2": null
},
"platforms": ["WIN"
]
}
]
}

createLibraryDefinition

Authorizations:

bearerAuth

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
name required	string
namespace required	string
engine required	string
location	string
	object
platforms	Array of strings (platformEnum) Items Enum: "WIN" "LINUX" "AIX" "MAC" "ZOS"

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"engine": "string",
"location": "string",
"options": {"property1": null,
"property2": null
},
"platforms": ["WIN"
]
}

Response samples

201

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"engine": "string",
"location": "string",
"options": {"property1": null,
"property2": null
},
"platforms": ["WIN"
]
}

nameAvailability

Authorizations:

bearerAuth

query Parameters

name required	string
namespace required	string

Responses

Response samples

200

Content type

application/json

{"result": true,
"reason": "invalid",
"msg": "string"
}

getLibraryDefinition

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"engine": "string",
"location": "string",
"options": {"property1": null,
"property2": null
},
"platforms": ["WIN"
]
}

deleteLibraryDefinition

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

putLibraryDefinition

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
namespace required	string
engine required	string
location	string
	object
platforms	Array of strings (platformEnum) Items Enum: "WIN" "LINUX" "AIX" "MAC" "ZOS"

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"engine": "string",
"location": "string",
"options": {"property1": null,
"property2": null
},
"platforms": ["WIN"
]
}

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"engine": "string",
"location": "string",
"options": {"property1": null,
"property2": null
},
"platforms": ["WIN"
]
}

patchLibraryDefinition

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

Payload

Content type

application/json-patch+json

[{"op": "add",
"path": "string",
"value": null
}
]

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"engine": "string",
"location": "string",
"options": {"property1": null,
"property2": null
},
"platforms": ["WIN"
]
}

getLibraryDefinitionSyntax

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

publishLibrary

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

executionProfileId required	string
sessionEncoding	string
workerPoolSize	integer

Responses

Request samples

Payload

Content type

application/json

{"executionProfileId": "string",
"sessionEncoding": "string",
"workerPoolSize": 0
}

Response samples

404

Content type

application/json

{"msg": "string"
}

queryBindingsForLibrary

Authorizations:

bearerAuth

path Parameters

id

required

string

query Parameters

filter[libname][EQ]	string
filter[libraryDefinitionId][EQ]	string
filter[principal][EQ]	string
filter[_created][LT]	string <date-time>
filter[_created][GT]	string <date-time>
page[offset]	integer
page[limit]	integer
sort	string Enum: "_created" "-_created" "libname" "-libname" "principal" "-principal" "libraryDefinitionId" "-libraryDefinitionId"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"libraryDefinitionId": "string",
"principal": "string",
"libname": "string"
}
],
"libraryDefinitions": {"property1": "string",
"property2": "string"
}
}

createLibnameBinding

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
libraryDefinitionId required	string
principal required	string
libname required	string

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"libraryDefinitionId": "string",
"principal": "string",
"libname": "string"
}

Response samples

202

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"libraryDefinitionId": "string",
"principal": "string",
"libname": "string"
}

getLibnameBinding

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"libraryDefinitionId": "string",
"principal": "string",
"libname": "string"
}

putLibnameBinding

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
libraryDefinitionId required	string
principal required	string
libname required	string

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"libraryDefinitionId": "string",
"principal": "string",
"libname": "string"
}

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"libraryDefinitionId": "string",
"principal": "string",
"libname": "string"
}

patchLibnameBinding

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

Payload

Content type

application/json-patch+json

[{"op": "add",
"path": "string",
"value": null
}
]

Response samples

200
404

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"libraryDefinitionId": "string",
"principal": "string",
"libname": "string"
}

deleteLibnameBinding

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getAutolibs

Authorizations:

bearerAuth

Responses

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
filter[active][EQ]	boolean
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" "namespace" "-namespace" "created" "-created" "modified" "-modified"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"libraryDefinitionId": "string",
"name": "string",
"namespace": "string",
"libraryEngine": "string",
"libraryLocation": "string",
"libraryOptions": "string",
"active": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"status": {"servers": [{"node": "string",
"address": "string"
}
]
},
"executionProfileId": "string",
"sessionEncoding": "string",
"workerPoolSize": 0
}
]
}

getPublishedLibrary

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"libraryDefinitionId": "string",
"name": "string",
"namespace": "string",
"libraryEngine": "string",
"libraryLocation": "string",
"libraryOptions": "string",
"active": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"status": {"servers": [{"node": "string",
"address": "string"
}
]
},
"executionProfileId": "string",
"sessionEncoding": "string",
"workerPoolSize": 0
}

unpublishLibrary

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

patchPublishedLibrary

This offers a limited set of patches. All that can be changed is the 'executionProfileId' and 'active' fields, and the only operation that is supported is 'replace'.

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

Payload

Content type

application/json-patch+json

[{"op": "add",
"path": "string",
"value": null
}
]

Response samples

200
404

Content type

application/json

{"libraryDefinitionId": "string",
"name": "string",
"namespace": "string",
"libraryEngine": "string",
"libraryLocation": "string",
"libraryOptions": "string",
"active": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"status": {"servers": [{"node": "string",
"address": "string"
}
]
},
"executionProfileId": "string",
"sessionEncoding": "string",
"workerPoolSize": 0
}

activatePublishedLibrary

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

deactivatePublishedLibrary

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}