Summary
Import a prebuilt.
Description
Import a prebuilt into IAP.
Route
POST /prebuilts/import
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| prebuilt |
object |
yes |
The data for a prebuilt. |
| options |
object |
yes |
Options for importing a Pre-built |
Copied to Clipboard
{
"prebuilt": {
"metadata": {
"name": "@itentialopensource/aggregate-functions-for-arrays",
"version": "1.1.1-2020.1.0",
"description": "A basic description",
"author": "Itential Artifacts",
"license": "Apache-2.0",
"repository": {
"type": "gitlab",
"hostname": "localhost",
"path": "/itentialopensource/pre-built-automations"
},
"keywords": [
"Itential",
"Itential",
"Itential"
],
"gitlabId": 17866482
},
"manifest": {
"bundleName": "aggregateFunctions",
"artifacts": [
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "aggregateFunctions",
"type": "mop-analytic-template",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
},
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "aggregateFunctions",
"type": "service-catalog",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
}
],
"fingerprint": "5e84f892c5eab11ec2eee16d",
"createdEpoch": "1585772690392"
},
"bundles": [
{
"type": "service-catalog"
},
{
"type": "mop-template"
},
{
"type": "json-forms"
},
{
"type": "golden-config"
},
{
"type": "automation"
}
],
"readme": "example of readme"
},
"options": {
"overwrite": true
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"prebuilt": {
"title": "prebuilt",
"$ref": "prebuilts-schema"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"overwrite": {
"type": "boolean",
"description": "If the import functionality should overwrite existing components",
"examples": [
true,
false
]
}
}
}
},
"required": [
"prebuilt",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The output of the prebuilt import process. |
Copied to Clipboard
{
"status": "OK",
"message": "A sample success message",
"data": {
"metadata": {
"name": "@itentialopensource/cisco-nx-upgrade",
"version": "0.1.0",
"description": "A basic description",
"author": "Itential Artifacts",
"license": "Apache-2.0",
"repository": {
"type": "git",
"hostname": "gitlab.com",
"path": "/itentialopensource/pre-built-automations"
},
"keywords": [
"Itential",
"Itential",
"Itential",
"Itential",
"Itential"
],
"gitlabId": 17866482
},
"manifest": {
"bundleName": "aggregateFunctions",
"artifacts": [
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "aggregateFunctions",
"type": "workflow",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
},
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "aggregateFunctions",
"type": "workflow",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
},
{
"id": "5e5ea3bd16da51d52b4a8f9f",
"name": "aggregateFunctions",
"type": "forms",
"location": "/bundles/workflows/IAP Test Artifact Workflow.json"
}
],
"fingerprint": "5e84f892c5eab11ec2eee16d",
"createdEpoch": "1585772690392"
},
"bundles": [
{
"type": "template"
},
{
"type": "workflow"
}
],
"readme": "example of readme"
}
}
