PutREST

Step facilitates REST PUT interactions and will return the returned data dictionary and specified headers as data to the next step

Added in version 1.5.0.

Friendly name: PutREST
Step class: base_steps_syncpack.steps.PutREST.PutREST
Step version: 1.0.0
Required parameters: prefix_url

Parameters

This step adds no parameters of its own. It accepts exactly the parameters of Shared parameters: HTTPBaseStep.

Required inherited parameters

These are defined on Shared parameters: HTTPBaseStep but are required here, so a working configuration must set them.

Name	Type	Required	Default	Description
`prefix_url`	string	yes	–	used with relative_url to create the full URL. Example: `http://host.example.com`

Other inherited parameters

This step also accepts 31 optional parameter(s) inherited from Shared parameters: HTTPBaseStep.

Every step also accepts the platform parameters common to all steps – see Platform parameters.

Dependencies

Inherits from: PutREST -> HTTPBaseStep -> BaseStep -> Serializable
SyncPack modules: base_steps_syncpack.steps.HTTPBaseStep
External packages: ipaascommon

Behaviour

Fixes method = "PUT" and enable_paging = False, then delegates to Shared parameters: HTTPBaseStep. Registers no parameters of its own; identical in shape to PostREST apart from the HTTP verb.

Outputs

Same as PostREST: the response object from HTTPBaseStep, and on a StepFailedException carrying an error body, that body is saved for the next step before the exception is re-raised.

Example

{
  "prefix_url": "https://example.service-now.com",
  "relative_url": "/api/now/table/incident/abc123",
  "auth_method": "http_basic",
  "username": "svc_powerflow",
  "password": "${config.snow_password}",
  "payload": {"state": "6"}
}

Notes

The record identifier goes in relative_url. To take it from upstream data instead, set url_from_input — note that builds the URI from relative_url per input element, not from prefix_url.