GET - /recipes/ids

General Information

Service	API	Method	Data Models	Workflow

Service	API	Method	Data Models	Workflow
marketplace	/recipes/ids	GET	N/A	N/A

Description

List catalog recipes by selected ids

Input

Type: application/json

Input	Source	Required	Type	Description

Input	Source	Required	Type	Description
ids	query	No	Array of strings	To list by IDs

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

{
  "result": true,
  "data": [{
	_id: "5ef5a98e707a10af2f5d84c8",
	name: "Controller",
	type: "service",
	subtype: "nodejs",
	description: "Deploy Node.js service",
	restriction: {
		deployment: [
			"container"
		]
	},
	recipe: {
		deployOptions: {
			image: {
				prefix: "soajsorg",
				name: "gateway",
				tag: "latest",
				pullPolicy: "Always",
				repositoryType: "public",
				override: true,
				shell: "shell/bin/bash",
				binary: true
			},
			sourceCode: {},
			readinessProbe: {
				exec: {
					command: [
						"ls"
					]
				},
				initialDelaySeconds: 5,
				timeoutSeconds: 2,
				periodSeconds: 5,
				successThreshold: 1,
				failureThreshold: 4
			},
			livenessProbe: null,
			ports: [
				{
					name: "http",
					target: 80,
					isPublished: true,
					published: 30080
				}
			],
			voluming: [
				{
					docker: {},
					kubernetes: {
						volume: {
							name: "soajsprofile",
							secret: {
								secretName: "soajsprofile"
							}
						},
						volumeMount: {
							mountPath: "/opt/soajs/profile/",
							name: "soajsprofile"
						}
					}
				}
			],
			restartPolicy: {
				condition: "any",
				maxAttempts: 5
			},
			container: {
				network: "soajsnet",
				workingDir: ""
			},
			labels: {
				ragheb: "ragheb"
			},
			execCommands: {
				list: "ls -l"
			}
		},
		buildOptions: {
			env: {
				SOAJS_ENV: {
					type: "computed",
					value: "$SOAJS_ENV"
				},
				SOAJS_DEPLOY_HA: {
					type: "computed",
					value: "$SOAJS_DEPLOY_HA"
				},
				SOAJS_PROFILE: {
					type: "static",
					value: "/opt/soajs/profile/soajsprofile"
				},
				SOAJS_MONGO_CON_KEEPALIVE: {
					type: "static",
					value: "true"
				},
				SOAJS_EXTKEY: {
					type: "computed",
					value: "$SOAJS_EXTKEY"
				}
			},
			cmd: {
				deploy: {
					command: [
						"bash"
					],
					args: [
						"-c",
						"node ."
					]
				}
			}
		}
	},
	v: 1,
	ts: 1595250459348
}]
}

Invalid Response

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description

Code	Description
400	Business logic required data are missing
602	Model error: + %model_error%