Altair SLC Hub Ondemand (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

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

Lists the deployments

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[_created][LT]	string <date-time>
filter[_created][GT]	string <date-time>
filter[_modified][LT]	string <date-time>
filter[_modified][GT]	string <date-time>
filter[label][EQ]	string
filter[label][CO]	string
filter[path][EQ]	string
filter[path][CO]	string
filter[path][OV]	string Filters by paths that overlap with the given path.
filter[path][ST]	string
filter[_type][EQ]	string (deploymentType) Enum: "HubArtifact" "GitRepo"
filter[createApiEndpoint][EQ]	boolean
filter[active][EQ]	boolean
page[offset]	integer
page[limit]	integer
sort	string Enum: "path" "-path" "label" "-label" "_created" "-_created" "_modified" "-_modified"

Responses

Response samples

200
404

Content type

application/json

{"total": 0,
"data": [{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"path": "string",
"label": "string",
"categories": ["string"
],
"_type": "HubArtifact",
"createApiEndpoint": true,
"namespace": "string",
"executionProfileId": "string",
"active": true,
"repoUrl": "string",
"branchOrTag": "string"
}
]
}

Creates a deployment

Authorizations:

bearerAuth

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
path required	string
label	string
categories	Array of strings
_type required	string (deploymentType) GitRepo HubArtifact GitRepo
createApiEndpoint	boolean
namespace required	string
executionProfileId required	string
active	boolean
repoUrl	string
branchOrTag	string

Responses

Request samples

Payload

Content type

application/json

Example

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"path": "string",
"label": "string",
"categories": ["string"
],
"_type": "GitRepo",
"createApiEndpoint": true,
"namespace": "string",
"executionProfileId": "string",
"active": true,
"repoUrl": "string",
"branchOrTag": "string"
}

Response samples

201
404

Content type

application/json

Example

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"path": "string",
"label": "string",
"categories": ["string"
],
"_type": "GitRepo",
"createApiEndpoint": true,
"namespace": "string",
"executionProfileId": "string",
"active": true,
"repoUrl": "string",
"branchOrTag": "string"
}

pathAvailability

Authorizations:

bearerAuth

query Parameters

path required	string
namespace required	string

Responses

Response samples

200

Content type

application/json

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

getDeployment

Returns the deployment with the given ID

Authorizations:

bearerAuth

path Parameters

deploymentId

required

string

ID of the deployment

Responses

Response samples

200
404

Content type

application/json

Example

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"path": "string",
"label": "string",
"categories": ["string"
],
"_type": "GitRepo",
"createApiEndpoint": true,
"namespace": "string",
"executionProfileId": "string",
"active": true,
"repoUrl": "string",
"branchOrTag": "string"
}

putDeployment

Updated the deployment with the given ID

Authorizations:

bearerAuth

path Parameters

deploymentId

required

string

ID of the deployment

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
path required	string
label	string
categories	Array of strings
_type required	string (deploymentType) GitRepo HubArtifact GitRepo
createApiEndpoint	boolean
namespace required	string
executionProfileId required	string
active	boolean
repoUrl	string
branchOrTag	string

Responses

Request samples

Payload

Content type

application/json

Example

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"path": "string",
"label": "string",
"categories": ["string"
],
"_type": "GitRepo",
"createApiEndpoint": true,
"namespace": "string",
"executionProfileId": "string",
"active": true,
"repoUrl": "string",
"branchOrTag": "string"
}

Response samples

200
404

Content type

application/json

Example

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"path": "string",
"label": "string",
"categories": ["string"
],
"_type": "GitRepo",
"createApiEndpoint": true,
"namespace": "string",
"executionProfileId": "string",
"active": true,
"repoUrl": "string",
"branchOrTag": "string"
}

deleteDeployment

Deletes the deployment with the given ID

Authorizations:

bearerAuth

path Parameters

deploymentId

required

string

ID of the deployment

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

activateDeployment

Activate an existing deployment

Authorizations:

bearerAuth

path Parameters

deploymentId

required

string

ID of the deployment

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

deactivateDeployment

Deactivate an existing deployment

Authorizations:

bearerAuth

path Parameters

deploymentId

required

string

ID of the deployment

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

Lists the deployments

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[label][EQ]	string
filter[label][CO]	string
filter[programPath][EQ]	string
filter[programPath][ST]	string
filter[hasPermission]	string Enum: "Read" "Run"
page[offset]	integer
page[limit]	integer
sort	string Enum: "created" "-created" "label" "-label"

Responses

Response samples

200

Content type

application/json

{"data": [{"_id": "string",
"namespace": "string",
"_created": "string",
"label": "string",
"description": "string",
"categories": ["string"
],
"programPath": "string",
"asyncExecutionAllowed": true,
"syncExecutionAllowed": true,
"parameters": [{"name": "string",
"datatype": "bool",
"required": true,
"fixed": true,
"hidden": true,
"repeatable": true,
"label": "string",
"prompt": "string",
"validationService": "string",
"defaultValue": true
}
],
"uiform": {"type": "categorization",
"options": {"readonly": true,
"format": "radio"
},
"parameter": "string"
}
}
]
}

getDirectoryCategories

Returns all existing directory categories

Authorizations:

bearerAuth

query Parameters

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

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": ["string"
]
}

queryArtifacts

Authorizations:

bearerAuth

query Parameters

filter[repository][EQ]	string
filter[group][EQ]	string
filter[group][CO]	string
filter[group][ST]	string
filter[artifact][EQ]	string
filter[artifact][CO]	string
filter[artifact][ST]	string
filter[version][EQ]	string
filter[version][CO]	string
filter[version][ST]	string
filter[classifier][EQ]	string
filter[extension][EQ]	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: "repositoryId" "-repositoryId" "group" "-group" "artifact" "-artifact" "version" "-version" "classifier" "-classifier" "extension" "-extension" "created" "-created" "modified" "-modified"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"repositoryId": "string",
"group": "string",
"artifact": "string",
"version": "string",
"classifier": "string",
"extension": "string",
"info": {"sha256": "string",
"length": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"createdBy": "string"
}
}
]
}

queryDistinctArtifactFields

Authorizations:

bearerAuth

query Parameters

filter[repository][EQ]	string
filter[group][EQ]	string
filter[group][CO]	string
filter[group][ST]	string
filter[artifact][EQ]	string
filter[artifact][CO]	string
filter[artifact][ST]	string
filter[version][EQ]	string
filter[version][CO]	string
filter[version][ST]	string
filter[classifier][EQ]	string
filter[extension][EQ]	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
field	string Enum: "repositoryId" "group" "artifact" "version" "classifier" "extension"

Responses

Response samples

200

Content type

application/json

{"data": ["string"
],
"totalCount": 0
}

queryDistinctArtifactRGA

Authorizations:

bearerAuth

query Parameters

filter[repository][EQ]	string
filter[group][EQ]	string
filter[group][CO]	string
filter[group][ST]	string
filter[artifact][EQ]	string
filter[artifact][CO]	string
filter[artifact][ST]	string
filter[version][EQ]	string
filter[version][CO]	string
filter[version][ST]	string
filter[classifier][EQ]	string
filter[extension][EQ]	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: "repositoryId" "-repositoryId" "group" "-group" "artifact" "-artifact"

Responses

Response samples

200

Content type

application/json

{"data": [{"repositoryId": "string",
"group": "string",
"artifact": "string"
}
],
"totalCount": 0
}

getDistinctArtifactGroups

Authorizations:

bearerAuth

path Parameters

repositoryId

required

string

ID of the artifact repository

Responses

Response samples

200

Content type

application/json

{"data": ["string"
],
"totalCount": 0
}

deleteArtifactsByRepo

Authorizations:

bearerAuth

path Parameters

repositoryId

required

string

ID of the artifact repository

Responses

Response samples

200

Content type

application/json

{"count": 0
}

getDistinctArtifactNames

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string

Responses

Response samples

200

Content type

application/json

{"data": ["string"
],
"totalCount": 0
}

deleteArtifactsByGroup

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string

Responses

Response samples

200

Content type

application/json

{"count": 0
}

getDistinctArtifactVersions

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string

Responses

Response samples

200

Content type

application/json

{"data": ["string"
],
"totalCount": 0
}

deleteArtifactsByName

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string

Responses

Response samples

200

Content type

application/json

{"count": 0
}

getDistinctArtifactFilenames

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string
version required	string

Responses

Response samples

200

Content type

application/json

["string"
]

deleteArtifactsByVersion

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string
version required	string

Responses

Response samples

200

Content type

application/json

{"count": 0
}

getArtifactInfo

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string
version required	string
filename required	string

Responses

Response samples

200

Content type

application/json

{"sha256": "string",
"length": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"createdBy": "string"
}

getArtifactData

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string
version required	string
filename required	string

Responses

putArtifactData

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string
version required	string
filename required	string

Request Body schema: application/octet-stream

string <binary>

Responses

deleteArtifact

Authorizations:

bearerAuth

path Parameters

repositoryId required	string ID of the artifact repository
group required	string
artifact required	string
version required	string
filename required	string

Responses

Queries current artifact repository instances

Authorizations:

bearerAuth

query Parameters

filter[name][EQ]	string
filter[name][CO]	string
page[offset]	integer
page[limit]	integer
sort	string Enum: "name" "-name" "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",
"description": "string",
"allowPrereleaseVersions": true,
"allowReleaseVersions": true
}
]
}

createArtifactRepo

Creates a new artifact repository entity

Authorizations:

bearerAuth

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
name required	string
description	string
allowPrereleaseVersions	boolean
allowReleaseVersions	boolean

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"allowPrereleaseVersions": true,
"allowReleaseVersions": true
}

Response samples

201
409

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"allowPrereleaseVersions": true,
"allowReleaseVersions": true
}

Returns a specific artifact repository entity by ID

Authorizations:

bearerAuth

path Parameters

repositoryId

required

string

ID of the artifact repository

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",
"description": "string",
"allowPrereleaseVersions": true,
"allowReleaseVersions": true
}

Updates the definition of an artifact repository

Authorizations:

bearerAuth

path Parameters

repositoryId

required

string

ID of the artifact repository

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
name required	string
description	string
allowPrereleaseVersions	boolean
allowReleaseVersions	boolean

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"allowPrereleaseVersions": true,
"allowReleaseVersions": true
}

Response samples

200
404
409

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"allowPrereleaseVersions": true,
"allowReleaseVersions": true
}

Updates the definition of an artifact repository using JSON Patch

Authorizations:

bearerAuth

path Parameters

repositoryId

required

string

ID of the artifact repository

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
409

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"allowPrereleaseVersions": true,
"allowReleaseVersions": true
}

Deletes a specific artifact repository by ID

Authorizations:

bearerAuth

path Parameters

repositoryId

required

string

ID of the artifact repository

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

queryJobs

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[programPath][EQ]	string
filter[programPath][CO]	string
filter[label][CO]	string
filter[created][LT]	string <date-time>
filter[created][GT]	string <date-time>
filter[lastUpdated][LT]	string <date-time>
filter[lastUpdated][GT]	string <date-time>
filter[startedAt][LT]	string <date-time>
filter[startedAt][GT]	string <date-time>
filter[finishedAt][LT]	string <date-time>
filter[finishedAt][GT]	string <date-time>
page[offset]	integer
page[limit]	integer
filter[state][EQ]	string (asyncJobState) Enum: "Queued" "Cancelled" "Dispatched" "Downloading" "Executing" "ExecutionCompleted" "Finished"
filter[state][IN]	Array of strings (asyncJobState) Items Enum: "Queued" "Cancelled" "Dispatched" "Downloading" "Executing" "ExecutionCompleted" "Finished"
filter[completionState][EQ]	string (asyncJobCompletionState) Enum: "Success" "Error"
filter[ownerPrincipal][EQ]	string
filter[jobId][IN]	Array of strings
filter[jobId][EQ]	string
sort	string Enum: "created" "-created" "lastUpdated" "-lastUpdated" "programPath" "-programPath" "label" "-label"

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"created": "2019-08-24T14:15:22Z",
"programPath": "string",
"label": "string",
"ownerPrincipal": "string",
"emailPolicy": "ALWAYS",
"cancelled": true,
"status": {"state": "Queued",
"completionState": "Success",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "stateChanged",
"details": {"property1": "string",
"property2": "string"
}
}
]
},
"namespace": "string"
}
]
}

queryMyJobs

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[programPath][EQ]	string
filter[programPath][CO]	string
filter[label][CO]	string
filter[created][LT]	string <date-time>
filter[created][GT]	string <date-time>
filter[lastUpdated][LT]	string <date-time>
filter[lastUpdated][GT]	string <date-time>
filter[startedAt][LT]	string <date-time>
filter[startedAt][GT]	string <date-time>
filter[finishedAt][LT]	string <date-time>
filter[finishedAt][GT]	string <date-time>
page[offset]	integer
page[limit]	integer
filter[state][EQ]	string (asyncJobState) Enum: "Queued" "Cancelled" "Dispatched" "Downloading" "Executing" "ExecutionCompleted" "Finished"
filter[state][IN]	Array of strings (asyncJobState) Items Enum: "Queued" "Cancelled" "Dispatched" "Downloading" "Executing" "ExecutionCompleted" "Finished"
filter[completionState][EQ]	string (asyncJobCompletionState) Enum: "Success" "Error"
filter[jobId][IN]	Array of strings
filter[jobId][EQ]	string
sort	string Enum: "created" "-created" "lastUpdated" "-lastUpdated" "programPath" "-programPath" "label" "-label"

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"created": "2019-08-24T14:15:22Z",
"programPath": "string",
"label": "string",
"ownerPrincipal": "string",
"emailPolicy": "ALWAYS",
"cancelled": true,
"status": {"state": "Queued",
"completionState": "Success",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "stateChanged",
"details": {"property1": "string",
"property2": "string"
}
}
]
},
"namespace": "string"
}
]
}

deleteJob

Authorizations:

bearerAuth

path Parameters

jobId

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getJob

Authorizations:

bearerAuth

path Parameters

jobId

string

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"programPath": "string",
"label": "string",
"ownerPrincipal": "string",
"emailPolicy": "ALWAYS",
"cancelled": true,
"status": {"state": "Queued",
"completionState": "Success",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "stateChanged",
"details": {"property1": "string",
"property2": "string"
}
}
]
},
"namespace": "string"
}

cancelJob

Authorizations:

bearerAuth

path Parameters

jobId

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

repeatJob

Authorizations:

bearerAuth

path Parameters

jobId

string

Request Body schema: application/json

label

string

Responses

Request samples

Payload

Content type

application/json

{"label": "string"
}

Response samples

202
404

Content type

application/json

{"jobId": "string"
}

getJobLog

Authorizations:

bearerAuth

path Parameters

jobId

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getJobResults

Authorizations:

bearerAuth

path Parameters

jobId

string

Responses

Response samples

200
404

Content type

application/json

[{"name": "string",
"size": 0
}
]

getJobResultContent

Authorizations:

bearerAuth

path Parameters

jobId	string
resultName	string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getJobResultInfo

Authorizations:

bearerAuth

path Parameters

jobId	string
resultName	string

Responses

Response samples

200
404

Content type

application/json

{"name": "string",
"contentType": "string",
"size": 0
}

queryFavouriteJobs

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": ["string"
]
}

addFavouriteJob

Authorizations:

bearerAuth

Request Body schema: application/json

jobId

required

string

Responses

Request samples

Payload

Content type

application/json

{"jobId": "string"
}

Response samples

201
404

Content type

application/json

{"jobId": "string"
}

deleteFavouriteJob

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

queryFavouritePrograms

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": ["string"
]
}

addFavouriteProgram

Authorizations:

bearerAuth

Request Body schema: application/json

programId

required

string

Responses

Request samples

Payload

Content type

application/json

{"programId": "string"
}

Response samples

201
404

Content type

application/json

{"programId": "string"
}

deleteFavouriteProgram

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

Create/Update an artifact repo containing the Examples artifact, and create a deployment

Authorizations:

bearerAuth

Request Body schema: application/json

namespace required	string
executionProfileId required	string
path	string
createApiEndpoint	boolean

Responses

Request samples

Payload

Content type

application/json

{"namespace": "string",
"executionProfileId": "string",
"path": "string",
"createApiEndpoint": true
}

Response samples

404
409

Content type

application/json

{"msg": "string"
}