Initializing help system before first use

dmphttppatch

Purpose
Make an HTTP PATCH request to path within an initialized dmpresource.
Synopsis
function dmphttppatch(res:dmpresource, path:text, data:text, result:text):integer
function dmphttppatch(res:dmpresource, path:text, data:text, result:text, xhdr:text):integer
Arguments
res 
The dmpresource we want to access.
path 
The path we want to access within the DMP resource
data 
Data file to be sent as the request body
result 
File to store the result of the request
xhdr 
Additional headers to add to the request
Return value
The HTTP status code of the request, or 999 on a connection error.
Example 
declarations
  res: dmpresource
  httpstatus: integer
end-declarations
dmpinitcomp(res,"Xpress Executor")

httpstatus := dmphttppatch(res,'/rest/runtime/execution',
  'executionrequest.json', 'execution.json')
if httpstatus<>200 then
  if res.status<>DMP_OK then
    writeln('DMP Resource error: ',res.lasterror)
  else
    writeln('Unexpected HTTP status code: ',httpstatus)
  end-if
end-if
Further information
1. This function corresponds to the httppatch function of the mmhttp module and works in a similar way.
2. The request path is relative to the DMP resource's URL, unless it starts with the same path as the DMP resource URL and the abspath attribute has not been set to false, in which case it will be treated as an absolute path.
3. The outgoing HTTP request will be automatically augmented with the appropriate credentials for this type of dmpresource.
4. In event of an unexpected failure, the request will be retried the number of times specified by dmp_max_retries if it returned a HTTP status code listed in dmp_retry_error_codes.
5. If this function returns an unexpected HTTP status code, you should check the status attribute of the dmpresource to see whether this was returned from the HTTP webservice or was the result of an error obtaining credentials.

Parent Topic Procedures and functions

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation ("FICO"). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.