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": 25, "sort": "name", "order": 1 } }
{ "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" } } } }, "required": [ "queryOptions" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| results | object | Contains an array of prebuilts and the total in the response. |
{ "packages": [ { "name": "@itentialopensource/cisco-nx-upgrade", "version": "1.0.0", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "git", "url": "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git" }, "keywords": [ "Itential" ], "components": [ { "type": "workflows, forms", "name": "device-connection-health-check", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" } ], "readme": "A readme uses markdown text.", "_id": "5f46b038de73aa2264d5abab", "gitlabId": 17866482 }, { "name": "@itentialopensource/cisco-nx-upgrade", "version": "1.1.1-2020.1.0", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "git", "url": "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git" }, "keywords": [ "Itential", "Itential", "Itential", "Itential" ], "components": [ { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "device-connection-health-check", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" } ], "readme": "A readme uses markdown text.", "_id": "5f46b038de73aa2264d5abab", "gitlabId": 17866482 }, { "name": "@itentialopensource/cisco-nx-upgrade", "version": "0.1.0", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "git", "url": "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git" }, "keywords": [ "Itential" ], "components": [ { "type": "workflows, forms", "name": "device-connection-health-check", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "device-connection-health-check", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "device-connection-health-check", "id": "5e5ea3bd16da51d52b4a8f9f" } ], "readme": "A readme uses markdown text.", "_id": "5f46b038de73aa2264d5abab", "gitlabId": 17866482 }, { "name": "@itentialopensource/aggregate-functions-for-arrays", "version": "1.0.0", "description": "A basic description", "author": "Itential Artifacts", "license": "Apache-2.0", "repository": { "type": "git", "url": "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git" }, "keywords": [ "Itential", "Itential" ], "components": [ { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "device-connection-health-check", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" }, { "type": "workflows, forms", "name": "artifact-wizard", "id": "5e5ea3bd16da51d52b4a8f9f" } ], "readme": "A readme uses markdown text.", "_id": "5f46b038de73aa2264d5abab", "gitlabId": 17866482 } ], "total": 10 }
{ "title": "results", "type": "object", "required": [ "packages", "total" ], "properties": { "packages": { "type": "array", "items": { "$ref": "prebuilts-document-schema" } }, "total": { "$ref": "common-schema#/definitions/total" } } }