Altair SLC Hub Pipelines (2025.1.2)

Download OpenAPI specification:

queryPipelineFolderEntries

Queries pipeline folder entries

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[folderId][EQ]	string
filter[folderPath][EQ]	string
filter[_type][EQ]	string (pipelineEntityType) Enum: "Pipeline" "Folder"
filter[_id][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>
page[offset]	integer
page[limit]	integer
sort	string Enum: "_created" "-_created" "_modified" "-_modified" "name" "-name"

Responses

Response samples

200

Content type

application/json

{"data": [{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline"
}
],
"totalCount": 0
}

createPipelineTreeEntity

Creates a new pipeline or pipeline folder

Authorizations:

bearerAuth

Request Body schema:
application/json
required

_id	string
_created	string <date-time>
_modified	string <date-time>
name	string
namespace	string
_type	string (pipelineEntityType) Pipeline
folderId	string
folderPath	string
	object (pipelineSpec)

Responses

Request samples

Payload

Content type

application/json

Example

Pipeline

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline",
"folderId": "string",
"folderPath": "string",
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
}
}

Response samples

201
404
409

Content type

application/json

Example

Pipeline

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline",
"folderId": "string",
"folderPath": "string",
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
}
}

pipelineNameAvailability

Authorizations:

bearerAuth

query Parameters

name required	string
namespace required	string
folderId	string

Responses

Response samples

200

Content type

application/json

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

getPipelineTreeEntity

Authorizations:

bearerAuth

path Parameters

id

required

string

query Parameters

fields

Array of strings (pipelineFolderEntryEntityField)

Items Enum: "_id" "_created" "_modified" "_type" "name" "folderId" "folderPath"

Responses

Response samples

200
404

Content type

application/json

Example

Pipeline

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline",
"folderId": "string",
"folderPath": "string",
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
}
}

replacePipelineTreeEntity

Replaces the definition of the entity. In most cases it is preferable to use the PATCH method.

It is not permitted to change a pipeline into a folder or vice versa. The _id, _created and _modified fields in the request body are ignored

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json
required

_id	string
_created	string <date-time>
_modified	string <date-time>
name	string
namespace	string
_type	string (pipelineEntityType) Pipeline
folderId	string
folderPath	string
	object (pipelineSpec)

Responses

Request samples

Payload

Content type

application/json

Example

Pipeline

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline",
"folderId": "string",
"folderPath": "string",
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
}
}

Response samples

200
404
409

Content type

application/json

Example

Pipeline

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline",
"folderId": "string",
"folderPath": "string",
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
}
}

patchPipelineTreeEntity

Applies a modification to the entity using a JSON Patch document.

It is not permitted to change a pipeline into a folder or vice versa. Any attempt to change the _id, _created and _modified fields are ignored

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json-patch+json
required

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

Example

Pipeline

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline",
"folderId": "string",
"folderPath": "string",
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
}
}

deletePipelineTreeEntity

Deletes the given pipeline or folder. If a folder is specified, a recursive deletion of the folder and all its contents is performed.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

submitPipeline

Submits the pipeline, creating a pipeline run

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

executionProfileId

required

string

Responses

Request samples

Payload

Content type

application/json

{"executionProfileId": "string"
}

Response samples

201
404

Content type

application/json

{"pipelineRunId": "string"
}

validatePipeline

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"errors": ["string"
]
}

validatePipelineTreeEntity

Validates a new pipeline or pipeline folder

Authorizations:

bearerAuth

Request Body schema: application/json
required

_id	string
_created	string <date-time>
_modified	string <date-time>
name	string
namespace	string
_type	string (pipelineEntityType) Pipeline
folderId	string
folderPath	string
	object (pipelineSpec)

Responses

Request samples

Payload

Content type

application/json

Example

Pipeline

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"namespace": "string",
"_type": "Pipeline",
"folderId": "string",
"folderPath": "string",
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
}
}

Response samples

200

Content type

application/json

{"errors": ["string"
]
}

queryAllPipelineRuns

Queries current pipeline run instances

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[startedAt][LT]	string <date-time>
filter[startedAt][GT]	string <date-time>
filter[finishedAt][LT]	string <date-time>
filter[finishedAt][GT]	string <date-time>
filter[state][EQ]	string (pipelineRunState) Enum: "Queued" "Executing" "Succeeded" "Failed" "Cancelled"
filter[state][IN]	string
filter[ownerPrincipal][EQ]	string
filter[pipelineId][EQ]	string
page[offset]	integer
page[limit]	integer
sort	string Enum: "created" "-created"

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"created": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"state": "Queued",
"cancelled": true,
"ownerPrincipal": "string",
"namespace": "string",
"executionProfileId": "string"
}
],
"totalCount": 0
}

createPipelineRun

Authorizations:

bearerAuth

Request Body schema: application/json
required

Creates a new pipeline run.
The definition of the pipeline. In the definition any value for the id, status or created fields will be ignored. That is, only the spec field is honoured

id	string
created	string <date-time>
ownerPrincipal	string
pipelineId	string
pipelinePath	string
	object (pipelineRunStatus)
required	object (pipelineSpec)
entryPoint	string
executionProfileId required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"ownerPrincipal": "string",
"pipelineId": "string",
"pipelinePath": "string",
"status": {"state": "Queued",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"nodeStatus": {"property1": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
},
"property2": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
}
}
},
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
},
"entryPoint": "string",
"executionProfileId": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"ownerPrincipal": "string",
"pipelineId": "string",
"pipelinePath": "string",
"status": {"state": "Queued",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"nodeStatus": {"property1": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
},
"property2": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
}
}
},
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
},
"entryPoint": "string",
"executionProfileId": "string"
}

getPipelineRun

Returns the given pipeline run

Authorizations:

bearerAuth

path Parameters

pipelineRunId

required

string

ID of the pipeline run

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"created": "2019-08-24T14:15:22Z",
"ownerPrincipal": "string",
"pipelineId": "string",
"pipelinePath": "string",
"status": {"state": "Queued",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"nodeStatus": {"property1": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
},
"property2": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
}
}
},
"spec": {"nodes": [{"name": "string",
"connections": {"onSuccess": ["string"
],
"onTrue": ["string"
],
"onFalse": ["string"
],
"onAny": ["string"
],
"onError": ["string"
]
},
"inputs": {"resources": {"property1": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
},
"property2": {"type": "git",
"repo": "string",
"branchOrTag": "string",
"revision": "string",
"depth": 0,
"relativePath": "string"
}
}
},
"outputs": {"artifacts": {"property1": {"path": "string",
"contentType": "string"
},
"property2": {"path": "string",
"contentType": "string"
}
}
},
"task": {"type": "rawexec",
"command": "string",
"args": ["string"
],
"envVars": [{"name": "string",
"value": "string"
}
],
"conditionNode": true
},
"meta": { }
}
],
"meta": { },
"keepGoing": true
},
"entryPoint": "string",
"executionProfileId": "string"
}

deletePipelineRun

Deletes the given pipeline run

Authorizations:

bearerAuth

path Parameters

pipelineRunId

required

string

ID of the pipeline run

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getPipelineStatus

Returns the current status of a given pipeline run by ID

Authorizations:

bearerAuth

path Parameters

pipelineRunId

required

string

ID of the pipeline run

Responses

Response samples

200
404

Content type

application/json

{"state": "Queued",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"nodeStatus": {"property1": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
},
"property2": {"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
}
}
}

getAllNodeResultsForPipelineRun

Returns a list of the results generated by all nodes in the given pipeline run

Authorizations:

bearerAuth

path Parameters

pipelineRunId

required

string

ID of the pipeline run

Responses

Response samples

200
404

Content type

application/json

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

getPipelineRunNodeStatus

Returns the current status of a specific node in the given pipeline run

Authorizations:

bearerAuth

path Parameters

pipelineRunId required	string ID of the pipeline run
nodeName required	string Name of the pipeline node

Responses

Response samples

200
404

Content type

application/json

{"state": "Created",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"exitCode": 0,
"events": [{"time": "2019-08-24T14:15:22Z",
"type": "string",
"details": {"property1": "string",
"property2": "string"
}
}
]
}

getPipelineRunNodeLog

Returns the standard output or standard error log from execution of a given node in a pipeline run

Authorizations:

bearerAuth

path Parameters

pipelineRunId required	string ID of the pipeline run
nodeName required	string Name of the pipeline node
logType required	string Enum: "stdout" "stderr" Type of log to return

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getPipelineRunNodeResults

Returns a list of the results generated by the given node in a pipeline run

Authorizations:

bearerAuth

path Parameters

pipelineRunId required	string ID of the pipeline run
nodeName required	string Name of the pipeline node

Responses

Response samples

200
404

Content type

application/json

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

getPipelineRunNodeResultContent

Returns the content of the given node result

Authorizations:

bearerAuth

path Parameters

pipelineRunId required	string ID of the pipeline run
nodeName required	string Name of the pipeline node
resultName required	string Name of the result

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getPipelineRunNodeResultInfo

Returns info for the given node result

Authorizations:

bearerAuth

path Parameters

pipelineRunId required	string ID of the pipeline run
nodeName required	string Name of the pipeline node
resultName required	string Name of the result

Responses

Response samples

200
404

Content type

application/json

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

cancelPipelineRun

Requests cancellation of a pipeline run

Authorizations:

bearerAuth

path Parameters

pipelineRunId

required

string

ID of the pipeline run

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

queryPipelineTriggers

Queries triggers for a given pipeline

Authorizations:

bearerAuth

path Parameters

id

required

string

query Parameters

filter[type][EQ]	string (triggerType) Enum: "Cron" "File"
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[disabled][EQ]	boolean
page[offset]	integer
page[limit]	integer
sort	string Enum: "created" "-created" "modified" "-modified"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modifed": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"lastTriggered": "2019-08-24T14:15:22Z",
"executionProfileId": "string"
}
]
}

createTrigger

Creates a new trigger

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json
required

id	string
pipelineId required	string
created	string <date-time>
modified	string <date-time>
runAsPrincipal	string
disabled required	boolean
required	any (triggerSpec)
executionProfileId required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"executionProfileId": "string"
}

Response samples

201
409

Content type

application/json

{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"executionProfileId": "string"
}

queryTriggers

Queries triggers

Authorizations:

bearerAuth

query Parameters

filter[namespace][EQ]	string
filter[namespace][IN]	Array of strings
filter[type][EQ]	string (triggerType) Enum: "Cron" "File"
filter[pipelineId][EQ]	string
filter[runAsPrincipal][EQ]	string
filter[executionProfile][EQ]	string
filter[disabled][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: "created" "-created" "modified" "-modified"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modifed": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"lastTriggered": "2019-08-24T14:15:22Z",
"executionProfileId": "string"
}
]
}

getTrigger

Returns a pipeline trigger by ID

Authorizations:

bearerAuth

path Parameters

triggerId

required

string

ID of the trigger

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"executionProfileId": "string"
}

deleteTrigger

Deletes a trigger by ID

Authorizations:

bearerAuth

path Parameters

triggerId

required

string

ID of the trigger

Responses

Response samples

204
404

Content type

application/json

{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"executionProfileId": "string"
}

putTrigger

Replaces the definition of the given trigger.
The values of the created and modified fields in the request body are ignored. If present the id field must match the ID of the trigger

Authorizations:

bearerAuth

path Parameters

triggerId

required

string

ID of the trigger

Request Body schema: application/json
required

id	string
pipelineId required	string
created	string <date-time>
modified	string <date-time>
runAsPrincipal	string
disabled required	boolean
required	any (triggerSpec)
executionProfileId required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"executionProfileId": "string"
}

Response samples

200
404
409

Content type

application/json

{"id": "string",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"executionProfileId": "string"
}

patchTrigger

Patches the trigger with a JSON Patch document

Authorizations:

bearerAuth

path Parameters

triggerId

required

string

ID of the trigger

Request Body schema: application/json-patch+json
required

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",
"pipelineId": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"runAsPrincipal": "string",
"disabled": true,
"trigger": {"type": "Cron",
"cronExpression": "string",
"timezone": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
},
"executionProfileId": "string"
}

getTriggerHistory

Returns the history of firings of the given trigger

Authorizations:

bearerAuth

path Parameters

triggerId

required

string

ID of the trigger

query Parameters

filter[triggerTime][LT]	string <date-time>
filter[triggerTime][GT]	string <date-time>
page[offset]	integer
page[limit]	integer
sort	string Enum: "triggerTime" "-triggerTime" "triggerId" "-triggerId"

Responses

Response samples

200
404

Content type

application/json

{"totalCount": 0,
"data": [{"triggerId": "string",
"triggerTime": "2019-08-24T14:15:22Z",
"runId": "string",
"error": "string",
"state": "Success"
}
]
}

queryTriggerHistory

Queries trigger firings for all triggers

Authorizations:

bearerAuth

query Parameters

filter[triggerId][EQ]	string
filter[triggerTime][LT]	string <date-time>
filter[triggerTime][GT]	string <date-time>
page[offset]	integer
page[limit]	integer
sort	string Enum: "triggerTime" "-triggerTime" "triggerId" "-triggerId"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"triggerId": "string",
"triggerTime": "2019-08-24T14:15:22Z",
"runId": "string",
"error": "string",
"state": "Success"
}
]
}

Altair SLC Hub Pipelines (2025.1.2)

queryPipelineFolderEntries

Authorizations:

query Parameters

Responses

Response samples

createPipelineTreeEntity

Authorizations:

Request Body schema: application/jsonapplication/yamlapplication/jsonrequired

Responses

Request samples

Response samples

pipelineNameAvailability

Authorizations:

query Parameters

Responses

Response samples

getPipelineTreeEntity

Authorizations:

path Parameters

query Parameters

Responses

Response samples

replacePipelineTreeEntity

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

patchPipelineTreeEntity

Authorizations:

path Parameters

Request Body schema: application/json-patch+jsonrequired

Responses

Request samples

Response samples

deletePipelineTreeEntity

Authorizations:

path Parameters

Responses

Response samples

submitPipeline

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

validatePipeline

Authorizations:

path Parameters

Responses

Response samples

validatePipelineTreeEntity

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

queryAllPipelineRuns

Authorizations:

query Parameters

Responses

Response samples

createPipelineRun

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getPipelineRun

Authorizations:

path Parameters

Responses

Response samples

deletePipelineRun

Authorizations:

path Parameters

Responses

Request Body schema:
application/json
required

Request Body schema: application/json
required

Request Body schema: application/json-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required