File Upload Results Integration Point

This integration point enables you to update the uploadSuccess field of an existing file upload result.

Operations

Operation	Endpoint	Description
PATCH	http://[hostName]:[portNumber]/[api-context-root]/fileuploadresults/{id}	Updates the uploadSuccess field for a specific file upload result.

Rules

Update Behavior

The uploadSuccess field can be updated only if all the following conditions are met:

1. The step of the upload result is Delivery.

2. The type of the upload is Agent.

3. The upload result is linked to an exchange step where the receiveAgentNotification sub-step status is failed.

Additional Rules

• Only the uploadSuccess field can be updated through this integration point.

• Other fields of the file upload result remain unchanged.

• Once a file is marked as successfully uploaded, that status cannot be changed back.

Create and delete operations do not apply to this integration point.

Update Request

PATCH on

http://[hostName]:[portNumber]/[api-context-root]/fileuploadresults/{id}

Example Payload

{
  "uploadSuccess": true
}

• uploadSuccess indicates whether the file upload was successful.

Error Messages

The following messages can be returned in the response.

Table 1. Error Messages

Code/Response	Severity	Message
OIG-IP-FIUR-001	Fatal	File upload result can only be updated for type Agent.
OIG-IP-FIUR-002	Fatal	Only the uploadSuccess field can be updated.
OIG-IP-FIUR-003	Fatal	uploadSuccess can only be updated from null or false to true.
OIG-IP-FIUR-004	Fatal	The associated exchange step must have failed status to update uploadSuccess.

The listed error messages are related to the HTTP 422 (Unprocessable Entity) status code.

For more information, see Response Messages.

Authorization

This integration point requires a grant for the fileuploadresults IP access restriction.