Skip Updates (v2)

This Rest API version contains all parameters in the payload and does not require URL encoding while calling the REST APIs. This makes the v2 API easier to use. The v2 version is backwards compatible.

Required Roles

Service Administrator

REST Resource

POST /interop/rest/v2/services/skipupdate

Request

Supported Media Types: application/json

Table 9-114 Parameters

Name	Description	Type	Required	Default
type	The desired action to be performed (Add, List, or Remove)	Payload	Yes	None
version	The version to be skipped from update, for example, 22.12	Payload	No (Yes, only when the type is Add)	None
comment	The business reason for skipping an update, such as Year End	Payload	No (Yes, only when the type is Add)	None

Sample Request Payload

{
  "type": "Add",
  "parameters": {
    "version": "<VERSION>",
    "comment": "<COMMENT>"
  }
}

Response

Supported Media Types: application/json

Table 9-115 Parameters

Name	Description
details	In the case of errors, details are published with the error string
status	See Migration Status Codes
links	Detailed information about the link
href	Links to API call or status API
action	The HTTP call type
rel	Possible values: self or Job Status. If the value is set to Job Status, you can use the href to get the status
data	null

Example of Response Body

{
	"status": 0,
	"items": null,
	"links": [{
		"rel": "self",
		"href": "https://<BASE-URL>/interop/rest/v2/services/skipupdate",
		"data": null,
		"action": "POST"
	}
	"details": null
}

Sample cURL Command

curl -X POST -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' -d '{"type":"Add","parameters":{"version":"22.10","comment":"Year End"}}' 'https://<BASE URL>/interop/rest/v2/services/skipupdate'