Skip Updates (v1)

This topic describes the original version of this REST API. You can also use the simplified v2 version of the REST API. The v2 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/v1/services/skipupdate

Request

Supported Media Types: application/x-www-form-urlencoded

Table 9-112 Parameters

Name Description Type Required Default
type The desired action to be performed (Add, List, or Remove) Form Yes None
version The version to be skipped from update, for example, 20.12 Form

No

(Yes, only when the type is Add)

None
comment

The business reason for skipping an update, such as Year End

 Form

No

(Yes, only when the type is Add)

None

Sample Request Payload (Add)

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

Sample Request Payload (Remove)

{
  "type": "Remove",
  }

Sample Request Payload (List)

{
  "type": "List",
  }

Response

Supported Media Types: application/json

Table 9-113 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 Parameters as key value pairs passed in the request

Example of Response Body (Skip Updates - Add, Remove)

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

Example of Response Body (Skip Updates - List)

{
  "details": null,
  "status": 0,
  "items": [
    {
      "User": "<USERNAME>",
      "Version": "<VERSION>",
      "Comments": "<COMMENT>",
      "Timestamp": "<TIMESTAMP>"
    }
  ],
  "links": [
    {
      "href": "https://<BASE-URL>/interop/rest/v1/services/skipupdate",
      "action": "POST",
      "rel": "self",
      "data": null
    }
  ]
}
[
  {
    "User": "<USERNAME>",
    "Version": "<VERSION>",
    "Comments": "<COMMENT>",
    "Timestamp": "<TIMESTAMP>"
  }
]

Sample cURL Command (Add)

curl -s -u <USERNAME>:<PASSWORD> -H 'Content-Type: application/x-www-form-urlencoded' --request POST https://<BASE-URL>/interop/rest/v1/services/skipupdate -d 'type=Add&version=<VERSION>&comment=<COMMENT>

Sample cURL Command (Remove)

curl -s -u <USERNAME>:<PASSWORD> -H 'Content-Type: application/x-www-form-urlencoded' --request POST https://<BASE-URL>/interop/rest/v1/services/skipupdate -d type=Remove

Sample cURL Command (List)

curl -s -u <USERNAME>:<PASSWORD> -H 'Content-Type: application/x-www-form-urlencoded' --request POST https://<BASE-URL>/interop/rest/v1/services/skipupdate -d type=List