FileReceived

Third-party applications send POST requests to the FileReceived REST service to perform operations such as activity creation, data insertion, quote generation, and illustration processing.

The FileReceived API uses AsFile configuration to perform operations on OIPA entities that includes creation and execution of PreInsert and PostInsert processing. AsFile, as part of OIPA web services, allows incoming XML data to be processed, transformed, and then persisted to the database through OIPA processing. The AsFile configuration consists of XSLT and XML Data, which must be configured to process incoming XML requests. The FileReceived API accepts payloads in JSON and XML formats and uses the AsFile configuration for processing them.

Configuration and Prerequisites

• The configurator must create AsFile Input and Output configurations (XML Data and XSLT) in the Rules Palette to implement a FileReceived request.

• The properties in the request payload must match the structure defined in the AsFile configuration.

• The request payload must include all properties required as per the mappings defined in the AsFile configuration.

Endpoint

Operation	Method	Path
FileReceived	POST	/PASJava/rest/fileReceived

Process Flow

• Once OIPA receives the payload, it invokes the FileReceived service flow and executes PreInsert and PostInsert operations.

• Based on the validation and processing results, OIPA builds the response and sends it to the requester with appropriate HTTP status codes.

Note:

As a best practice, use this API for entities that require PreInsert and PostInsert processing, such as activity creation with immediate processing.