Altair SLC Hub Execution Profiles (2.3.0.461)

Download OpenAPI specification:Download

Authentication

bearerAuth

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

queryExecutionProfiles

Authorizations:

bearerAuth

query Parameters

filter[name][EQ]	string
filter[name][CO]	string
filter[name][SW]	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>
filter[hasPermission]	string Enum: "Read" "Use" "Delete" "Update"
filter[hasBindingTo]	Array of strings
filter[isDefaultFor]	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"
}
]
}

createExecutionProfile

Authorizations:

bearerAuth

Request Body schema: application/json

_id	string
_created	string <date-time>
_modified	string <date-time>
name required	string
description	string
isDefault	boolean
environment	object A map of all environment variables to run under
	Array of objects (constraint) List of constraints to apply to profile
properties	object

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",
"isDefault": true,
"environment": { },
"constraints": [{"attribute": "string",
"value": "string",
"operator": "string"
}
],
"properties": { }
}

Response samples

201

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"isDefault": true,
"environment": { },
"constraints": [{"attribute": "string",
"value": "string",
"operator": "string"
}
],
"properties": { }
}

nameAvailability

Authorizations:

bearerAuth

query Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

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

getExecutionProfile

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",
"description": "string",
"isDefault": true,
"environment": { },
"constraints": [{"attribute": "string",
"value": "string",
"operator": "string"
}
],
"properties": { }
}

deleteExecutionProfile

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

putExecutionProfile

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
environment	object A map of all environment variables to run under
	Array of objects (constraint) List of constraints to apply to profile
properties	object

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",
"isDefault": true,
"environment": { },
"constraints": [{"attribute": "string",
"value": "string",
"operator": "string"
}
],
"properties": { }
}

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",
"isDefault": true,
"environment": { },
"constraints": [{"attribute": "string",
"value": "string",
"operator": "string"
}
],
"properties": { }
}

patchExecutionProfile

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",
"description": "string",
"isDefault": true,
"environment": { },
"constraints": [{"attribute": "string",
"value": "string",
"operator": "string"
}
],
"properties": { }
}

getExecutionProfileProperties

Authorizations:

bearerAuth

path Parameters

id

required

string

query Parameters

expand

boolean

If true, the endpoint returns the properties with substitutions expanded.

Responses

Response samples

200
404

Content type

application/json

{ }

getDefaultExecutionProfile

Authorizations:

bearerAuth

query Parameters

namespace

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"_created": "2019-08-24T14:15:22Z",
"_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"isDefault": true,
"environment": { },
"constraints": [{"attribute": "string",
"value": "string",
"operator": "string"
}
],
"properties": { }
}

queryBindings

Authorizations:

bearerAuth

query Parameters

filter[executionProfileId][EQ]	string
filter[namespaceId][EQ]	string
page[offset]	integer
page[limit]	integer
sort	string Enum: "executionProfileId" "-executionProfileId" "namespaceId" "-namespaceId"

Responses

Response samples

200

Content type

application/json

{"totalCount": 0,
"data": [{"executionProfileId": "string",
"namespaceId": "string",
"id": "string",
"isDefault": true
}
],
"executionProfiles": {"property1": "string",
"property2": "string"
}
}

createBinding

Authorizations:

bearerAuth

Request Body schema: application/json

executionProfileId required	string
namespaceId required	string
id required	string
isDefault	boolean

Responses

Request samples

Payload

Content type

application/json

{"executionProfileId": "string",
"namespaceId": "string",
"id": "string",
"isDefault": true
}

Response samples

202

Content type

application/json

{"executionProfileId": "string",
"namespaceId": "string",
"id": "string",
"isDefault": true
}

getBinding

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{"executionProfileId": "string",
"namespaceId": "string",
"id": "string",
"isDefault": true
}

putBinding

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

executionProfileId required	string
namespaceId required	string
id required	string
isDefault	boolean

Responses

Request samples

Payload

Content type

application/json

{"executionProfileId": "string",
"namespaceId": "string",
"id": "string",
"isDefault": true
}

Response samples

200
404

Content type

application/json

{"executionProfileId": "string",
"namespaceId": "string",
"id": "string",
"isDefault": true
}

patchBinding

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

{"executionProfileId": "string",
"namespaceId": "string",
"id": "string",
"isDefault": true
}

deleteBinding

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}