API Page Types

[system]

Data page can be used to expose CRUD data operations.

ORIGAM can handle the following page types:

1150×1150 16.3 KB

Data Page Data page can be used to expose CRUD data operations.Using a Data Page you can Expose data in different formats (XML, JSON, HTML, CSV…) using GET and POST requests Insert or update records using PUT requests Delete records using DELETE requests Attributes DataStructure Data Structure the data will be based on. Method Optional method (filter) to be used for getting the data. SortSet Optional sort set using which the data will be sorted. Transformation Optional XSLT Tr…

1150×1150 16.3 KB

File Download Page Using this element you can define an API using which you will be able to download binary objects (BLOB) from the database, e.g. record attachments. Attributes DataStructure Data Structure that will load the file from the database. Method Method (filter) that will provide the needed file. SortSet Optional sort set using which the data will be sorted. FileNameField Field from the first entity in the provided data structure which contains the file name. Conte…

1150×1150 16.3 KB

Report Page

1150×1150 16.3 KB

Using Workflow API you can expose sequential workflow functionality through the API. You would use this API typically where simple Data Page would not provide enough functionality, e.g. when additional processing has to happen before storing the data into the database. Attributes Workflow A sequential workflow to be called when the API is accessed. Behavior Sequential workflow API’s currently do not return any data, although you can use the output contexts for managing where the HT…