Summary
Get all the prebuilts.
Description
Get all the prebuilts in IAP.
Route
GET /prebuilts
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"contains": "nso",
"containsField": "name",
"equals": "artifact-wizard",
"equalsField": "name",
"startsWith": "a",
"startsWithField": "name",
"skip": 0,
"limit": 1,
"sort": "name",
"order": 1,
"config": "@itentialopensource"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"nso"
]
},
"containsField": {
"type": "string",
"examples": [
"name"
]
},
"equals": {
"type": "string",
"examples": [
"artifact-wizard"
]
},
"equalsField": {
"type": "string",
"examples": [
"name"
]
},
"startsWith": {
"type": "string",
"examples": [
"n",
"a"
]
},
"startsWithField": {
"type": "string",
"examples": [
"name"
]
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
},
"config": {
"$ref": "common-schema#/definitions/config"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
results |
object |
Contains an array of prebuilts and the total in the response. |
Copied to Clipboard
{
"packages": [],
"total": 5
}