Summary
Get all the prebuilts.
Description
Get all the prebuilts in IAP.
Route
GET /prebuilts
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryOptions | object | yes | Options for query parameters. |
{ "queryOptions": { "contains": "nso", "containsField": "name", "equals": "artifact-wizard", "equalsField": "name", "startsWith": "n", "startsWithField": "name", "skip": 1, "limit": 50, "sort": "name", "order": 1, "config": "@itentialopensource" } }
{ "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
Name | Type | Description |
---|---|---|
results | object | Contains an array of prebuilts and the total in the response. |
{ "packages": [ { "metadata": { "name": "@itentialopensource/cisco-nx-upgrade", "version": "0.0.1", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "gitlab", "hostname": "localhost", "path": "/itentialopensource/pre-built-automations" }, "keywords": [ "Itential", "Itential" ], "gitlabId": 17866482 }, "manifest": { "bundleName": "aggregateFunctions", "artifacts": [ { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "transformation", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "json-forms", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "mop-template", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" } ], "fingerprint": "5e84f892c5eab11ec2eee16d", "createdEpoch": "1585772690392" }, "bundles": [ { "type": "automation" }, { "type": "integration-model" }, { "type": "mop-analytic-template" }, { "type": "service-catalog" }, { "type": "transformation" } ], "readme": "example of readme" }, { "metadata": { "name": "@itentialopensource/cisco-nx-upgrade", "version": "0.0.1", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "local", "hostname": "gitlab.com", "path": "/itentialopensource/pre-built-automations" }, "keywords": [ "Itential", "Itential", "Itential" ], "gitlabId": 17866482 }, "manifest": { "bundleName": "aggregateFunctions", "artifacts": [ { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "golden-config", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "template", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" }, { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "template", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" } ], "fingerprint": "5e84f892c5eab11ec2eee16d", "createdEpoch": "1585772690392" }, "bundles": [ { "type": "integration" }, { "type": "service-catalog" }, { "type": "template" } ], "readme": "example of readme" }, { "metadata": { "name": "@itentialopensource/aggregate-functions-for-arrays", "version": "0.0.1", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "local", "hostname": "localhost", "path": "/itentialopensource/pre-built-automations" }, "keywords": [ "Itential", "Itential", "Itential", "Itential" ], "gitlabId": 17866482 }, "manifest": { "bundleName": "aggregateFunctions", "artifacts": [ { "id": "5e5ea3bd16da51d52b4a8f9f", "name": "aggregateFunctions", "type": "json-forms", "location": "/bundles/workflows/IAP Test Artifact Workflow.json" } ], "fingerprint": "5e84f892c5eab11ec2eee16d", "createdEpoch": "1585772690392" }, "bundles": [ { "type": "forms" }, { "type": "mop-template" } ], "readme": "example of readme" }, { "metadata": { "name": "@itentialopensource/aggregate-functions-for-arrays", "version": "0.1.0", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "local", "hostname": "localhost", "path": "/itentialopensource/pre-built-automations" }, "keywords": [ "Itential", "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": "workflow" }, { "type": "workflow" }, { "type": "service-catalog" }, { "type": "integration" } ], "readme": "example of readme" } ], "total": 5 }
{ "title": "results", "type": "object", "required": [ "packages", "total" ], "properties": { "packages": { "type": "array", "items": { "$ref": "prebuilts-schema" } }, "total": { "$ref": "common-schema#/definitions/total" } } }