Save Manifest

Description

Save/Load manifest. Make sure manifest is a valid one. If manifest already exists, it gets overridden.

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/manifests

Copy

Request Body

Manifest of type(s) application/json Required

manifest

Show optional properties

{
	"creationTime": "string",
	"publishedDate": "string",
	"releases": [
		{
			"bom": [
				{
					"name": "string",
					"publicName": "string",
					"version": "string"
				}
			],
			"description": "string",
			"minCompatibleVcfVersion": "string",
			"product": "string",
			"releaseDate": "string",
			"version": "string"
		}
	],
	"sequenceNumber": 0,
	"version": 0
}

{
	"creationTime": "string",
	"publishedDate": "string",
	"recalledBundles": [
		{
			"recalledBundleIds": [
				"string"
			],
			"replacementBundleIds": [
				"string"
			],
			"replacementBundleStatus": "One among: NONE, PENDING, READY"
		}
	],
	"releases": [
		{
			"bom": [
				{
					"additionalMetadata": "string",
					"name": "string",
					"publicName": "string",
					"releaseURL": {
						"authority": "string",
						"content": {},
						"defaultPort": 0,
						"file": "string",
						"host": "string",
						"path": "string",
						"port": 0,
						"protocol": "string",
						"query": "string",
						"ref": "string",
						"userInfo": "string"
					},
					"version": "string"
				}
			],
			"description": "string",
			"eol": "string",
			"isApplicable": false,
			"minCompatibleVcfVersion": "string",
			"notApplicableReason": "string",
			"patchBundles": [
				{
					"bundleElements": [
						"string"
					],
					"bundleId": "string",
					"bundleType": "string",
					"cumulativeFromVcfVersion": "string"
				}
			],
			"product": "string",
			"releaseDate": "string",
			"sku": [
				{
					"bom": [
						{
							"additionalMetadata": "string",
							"name": "string",
							"publicName": "string",
							"releaseURL": {
								"authority": "string",
								"content": {},
								"defaultPort": 0,
								"file": "string",
								"host": "string",
								"path": "string",
								"port": 0,
								"protocol": "string",
								"query": "string",
								"ref": "string",
								"userInfo": "string"
							},
							"version": "string"
						}
					],
					"description": "string",
					"name": "string",
					"skuSpecificPatchBundles": [
						{
							"bundleElements": [
								"string"
							],
							"bundleId": "string",
							"bundleType": "string",
							"cumulativeFromVcfVersion": "string"
						}
					]
				}
			],
			"updates": [
				{
					"baseProductVersion": "string",
					"description": "string",
					"id": "string",
					"productName": "string",
					"releaseDate": "string",
					"releaseUpdateURL": {
						"authority": "string",
						"content": {},
						"defaultPort": 0,
						"file": "string",
						"host": "string",
						"path": "string",
						"port": 0,
						"protocol": "string",
						"query": "string",
						"ref": "string",
						"userInfo": "string"
					}
				}
			],
			"version": "string"
		}
	],
	"sequenceNumber": 0,
	"version": 0
}

string

creationTime Required

Creation time for the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format

string

publishedDate Required

Date of publish of the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format

array of Release

releases Required

Releases of VCF in the ascending order of product version

integer as int32

sequenceNumber Required

Manifest sequence number which signifies an update in manifest

integer as int32

version Required

Manifest version supported by VCF

array of BundleRecall

recalledBundles Optional

Collection of bundles that are recalled and thier replacements, if applicable

Response

202 Accepted

Accepted

Operation doesn't return any data structure.

Errors

Error

400

Bad Request

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"creationTime":"string","publishedDate":"string","recalledBundles":[{"recalledBundleIds":["string"],"replacementBundleIds":["string"],"replacementBundleStatus":"One among: NONE, PENDING, READY"}],"releases":[{"bom":[{"additionalMetadata":"string","name":"string","publicName":"string","releaseURL":{"authority":"string","content":{},"defaultPort":0,"file":"string","host":"string","path":"string","port":0,"protocol":"string","query":"string","ref":"string","userInfo":"string"},"version":"string"}],"description":"string","eol":"string","isApplicable":false,"minCompatibleVcfVersion":"string","notApplicableReason":"string","patchBundles":[{"bundleElements":["string"],"bundleId":"string","bundleType":"string","cumulativeFromVcfVersion":"string"}],"product":"string","releaseDate":"string","sku":[{"bom":[{"additionalMetadata":"string","name":"string","publicName":"string","releaseURL":{"authority":"string","content":{},"defaultPort":0,"file":"string","host":"string","path":"string","port":0,"protocol":"string","query":"string","ref":"string","userInfo":"string"},"version":"string"}],"description":"string","name":"string","skuSpecificPatchBundles":[{"bundleElements":["string"],"bundleId":"string","bundleType":"string","cumulativeFromVcfVersion":"string"}]}],"updates":[{"baseProductVersion":"string","description":"string","id":"string","productName":"string","releaseDate":"string","releaseUpdateURL":{"authority":"string","content":{},"defaultPort":0,"file":"string","host":"string","path":"string","port":0,"protocol":"string","query":"string","ref":"string","userInfo":"string"}}],"version":"string"}],"sequenceNumber":0,"version":0}' https://sfo-vcf01.rainpole.io/v1/manifests