insightapi2~send_message_to_job
Purpose
Send a custom message to the job.
Synopsis
procedure send_message_to_job(client:insightapi2~insightconfig, req:insightapi2~httprequest, resp:insightapi2~httpresponse)
procedure send_message_to_job(client:insightapi2~insightconfig, id:text, body:insightapi2~job_message, resp:insightapi2~httpresponse)
procedure send_message_to_job(client:insightapi2~insightconfig, id:text, body:insightapi2~job_message)
Arguments
|
client
|
An initialized
insightapi2~insightconfig to call
|
||
|
req
|
An initialized
insightapi2~httprequest record. The
body field may be populated with a value of type
insightapi2~job_message. The
params field may contain these indexes:
|
||
|
id
|
The job ID
|
||
|
body
|
The job message
|
||
|
resp
|
A
insightapi2~httpresponse record into which will be written a description of the response
|
Further information
1. Use the
status field of the
resp record to distinguish between different status codes returned by the operation, or the
success attribute to check for 2xx status codes. If the
resp record is not passed to this procedure, the model will abort with a runtime error if the response's status code does not indicate success. The expected responses from this operation are:
| HTTP Status Code | Response body type | Description |
|---|---|---|
| 202 | The message for the job has been accepted | |
| 403 | The user did not have authority to send a message | |
| 404 | insightapi2~error_response | The job did not exist or was unavailable to the current user |
| 422 | insightapi2~error_response | The request was not well-formed. This may be because: * The request contains an incorrect executionId * The message is too long |
| 429 | insightapi2~error_response | There are currently too many messages waiting to be retrieved from the job |
2. If the response body could be read into a Mosel variable, it would be written to the
body field of the
resp record, and the
bodyfilename field of the
resp record will be an empty string.
3. If the
bodyfilename field of the
resp record is set to a non-empty value on return, this will be a file containing the response body; the caller is responsible for deleting this file when it is no longer required.
Related topics
insightapi2~error_response
insightapi2~job_message
insightapi2~insightconfig
insightapi2~httprequest
insightapi2~httpresponse
insightapi2~job_message
insightapi2~insightconfig
insightapi2~httprequest
insightapi2~httpresponse
© 2001-2023 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.