REST adapter request and response for the PATCH action

The PATCH action for the REST adapter sends updates to the specified URL.

When you use a context item as an input for an adapter request, you must enclose the adapter request in the <request-data> elements. However, when you create a static request, <request-data> is not required and the adapter request starts with the <rest-adapter-request> element.

Adapter requests for the REST adapter are in the JSON format. You specify the adapter name, header, and other parameters, which are converted to a JSON format. By default, the adapter response is in a JSON format.

The following figure describes the elements of an REST adapter request with a Patch action.

Elements of an REST adapter request with a Patch action

Element	Description	Required
<adapter name>	Specifies the name of the adapter Default name of the adapter is RESTAdapter	No
<url>	Specifies the target server URL to which you want to send data	Yes
<headers>	Specifies the header details for the adapter request, in a JSON format Sample header { "headers": { "authorization": "New Authentication Token" "Content-Type":"application/json" } } For more information, see Specifying header fields for the REST adapter.	No
<body>	Specifies the data to be posted to the target URL The <body> element accepts JSON format. JSON sample for specifying the <body> element { --- formatted json for patch --- } Sample format for specifying <body> for a multi-part data request { "op": "replace", "path": "/name", "value": "John" }	No
<return-data-format>	Indicates the data type for the adapter response. The adapter returns data only in the JSON format.	No
<use-ssl-certificate>	Determines whether to establish a secure connection Set the value of this element to true when <action> uses HTTPS. Set the value of this element to false or leave it blank when <action> uses HTTP. Valid values: true, false (default)	No
<allow-unsigned-certificate>	Specifies whether to allow unsigned certificates from trusted zones. If you are using self-signed SSL certificates (a common practice), specify true. Valid values: true, false (default)	No
<install-certificate>	Determines whether to install certificates. If true, the security certificates are installed automatically (a common practice). If false, the user must manually export the security certificate from the specified target server and manually import it to the cacerts file on a local peer. Valid values: true, false (default)	No
<passphrase>	Specifies the Java Standard Trust Keystore passphrase Default value: changeit Verify the cacerts passphrase using the following command in UNIX or Linux: $ /opt/bmc/ao/cdp/jvm/bin/keytool -list -keystore /opt/bmc/ao/cdp/jvm/lib/security/cacerts	No
<character-set>	Specifies the supporting CharSet Also called character set, it includes identifiers describing a series of universal characters. Note: If you do not specify the supporting character set, the adapter response is parsed based on the character set in the HTTP response header. Valid values for supported languages: Shift_JIS : Japanese character set Big5 : Traditional Chinese character set ISO-8859-2 : ISO character set for Central European languages.	No
<signature-properties>	Contains the elements that specify information about the public key (X.509 certificate) and the private key that are used for the digital signature Note: If you specify signature-properties in the adapter configuration and an adapter request, the values in the request override the values in the configuration. The <signature-properties> element can contain the mode attribute that specifies the format in which the public (X.509 certificate) and private keys are provided for signing the HTTP request. You can provide the keys using one of the following formats: Java Keystore (JKS) Privacy Enhanced Mail (PEM) Definite Encoding Rules (DER) files Base64-encoded PEM Valid values: <signature-properties mode="keystore"> (default) <signature-properties mode="key-files"> <signature-properties mode="key-data">	No
<private-key-file>	Specifies the file containing the private key that is used to sign the HTTP request The adapter supports the following formats: Base64-encoded PEM DER	Conditional; required when<signature-properties mode="key-files">
<certificate-file>	Specifies the file containing the public key (X509 Certificate) The adapter supports the following formats: Base64-encoded PEM DER	Conditional; required when<signature-properties mode="key-files">
<private-key-data>	Contains an XML file specifying the private key in an Base64-encoded PEM format For example: <private-key-data> --- BEGIN PRIVATE KEY --- MIICdQIBADANBgkqhkiG9w0 BAQEFAASCAl8wggJbAgEAAo GBAKomKro6VbW4PeQtUhNz ZpSH26vbBTBtH1r4EjnIv4vnh SyyA62ewpROVNn0Spvjo BFwE88HcX3tXym/zbVgtd Pke9K+SYHP6CWdiLqn ... --- END PRIVATE KEY -</private-key-data>	Conditional; required when<signature-properties mode="key-data">
<certificate-data>	Contains an XML file specifying the public key (X509 Certificate) in an Base64-encoded PEM format For example: <certificate-data> --- BEGIN CERTIFICATE --- MIICdzCCAeCgAwIBAgIFXseN1xYwDQYJKoZIhvcNAQEFBQ AwUzELMAkGA1UEBhMCVVMxEzARBgNVBAoTCkFtYXpvbi5jb20x DDAKBgNVBAsTA0FXUzEhMB8GA1UEAxMY ........ --- END CERTIFICATE -</certificate-data>	Conditional; required when<signature-properties mode="key-data">
<keystore-file>	Specifies the path to the JKS that contains the client certificate	Conditional; required when<signature-properties mode="keystore">
<key-password>	Specifies the password of the key contained in the JKS Note: If you do not specify <key-password>, then the value of<keystore-password> is used as the key password.	No
<keystore-password>	Specifies the password to the JKS	Conditional; required when<signature-properties mode="keystore">
<client alias>	Specifies the name of the alias in the JKS that identifies the Public Key Certificate (PKC) that the web server uses to authenticate the client Note: The value of the <alias> element is verified only when<install-certificate> is set to true and <allow-unsigned-certificate> is set to false.	Conditional; required when<signature-properties mode="keystore">
<enable-redirects>	Specifies whether the adapter should redirect a URL request to the changed URL location Valid values: true (default), false Note: If you specify <enable-redirects> in the adapter configuration and an adapter request, the values in the request override the values in the configuration.	No
<download-attachment>	Specifies whether the adapter should display the content of the attached file in the adapter response or save the content in a file Valid values: true, false (default) If <download-attachment>=true, the adapter checks the <content-disposition> field in the response header. If <content-disposition> contains attachment; file-name="abc.doc", the adapter saves the attached file. If the adapter response header does not contain the content-disposition field, the adapter checks the <content-type> field in the response header. If <content-type> contains an image or attachment, the adapter saves the attached file. If <download-attachment>=false, the content of the attached file is displayed in the adapter response.	No
<download-directory>	Specifies the full path where the attached file must be downloaded Default value: Temporary directory of the Java virtual machine of the peer	No
<request-timeout>	Specifies the time (in seconds) to wait when establishing a connection Default value: 10 seconds.	No
<ignore-line-break-in-response>	Specifies whether to ignore the line breaks while generating the adapter response If true, the line break markups are ignored and the response is returned as a single line. If false, the line break markers (if specified in the adapter response) are retained. Valid values: true (default), false	No
<secure-protocols>	Specifies the SSL/TLS protocols for establishing a network connection with a target server You can specify a single string value like SSLv3 or TLSv1 or a list of protocols separated by commas. Example: TLSv1,TLSv1.1,TLSv1.2	No

The following figure shows the sample XML request for the PATCH action.

<adapter-request>
   <target-adapter>rest-actor</target-adapter>
   <peer-location>
       <location>this</location>
   </peer-location>
   <request-action>patch</request-action>
   <request-data>
       <rest-adapter-request>
       <headers><![CDATA[
            {
               "url":"http://Endpoint-Url",
           "return-data-format":"XML",
               "headers": { "Authorization": "New Authentication Token",
               "Content-Type":"application/json" } }
             ]]></headers>
           <body><![CDATA[[

                       {
                       "op": "replace",
                       "path": "/address",
                       "value": "1.1.1.1"
                       },
                       {
                       "op": "replace",
                       "path": "/name",
                       "value": "John"
                       }

]
]]></body>
       </rest-adapter-request>
   </request-data>
</adapter-request>

The following figure shows the adapter response for the PATCH action.

{
  "rest-adapter-response":{
     "metadata":{
        "status":"success"
     },
     "status-line":{
        "code":"200",
        "reason":"OK"
     },
     "header-lines":{
        "Cache-Control":"no-cache, no-store, must-revalidate",
        "Pragma":"no-cache",
        "Content-Type":"application/json; charset=utf-8",
        "Expires":"-1",
        "Server":"Microsoft-IIS/8.5",
        "Set-Cookie":[
           "CAXXXX=; path=/PasswordVault/; HttpOnly",
         ],
        "api-supported-versions":"10.8",
        "X-UA-Compatible":"IE=EmulateIE8",
        "X-XSS-Protection":"1; mode=block",
        "X-Content-Type-Options":"nosniff",
        "X-FRAME-Options":"SAMEORIGIN",
        "Access-Control-Expose-Headers":"Warning",
        "Date":"Thu, 20 Aug 2020 09:17:14 GMT",
        "Content-Length":"331"
     },
     "message-body":{
        "id":"37_x",
        "name":"John",
        "address":"1.2.3.4",
        "userName":"vaultUserAccount",
        "platformId":"WinServerLocal",
        "safeName":"TestSafe",
        "secretType":"password",
        "platformAccountProperties":{
           "LogonDomain":"1.2.5.8"
        },
        "secretManagement":{
           "automaticManagementEnabled":true,
           "lastModifiedTime":1573610221
        },
        "createdTime":1573610221
     }
  }
}

REST adapter request and response for the PATCH action

On this page