-
Notifications
You must be signed in to change notification settings - Fork 1
Open
2 / 52 of 5 issues completedOpen
2 / 52 of 5 issues completed
Copy link
Labels
Description
The results of investigation - #2 (comment)
OIH Action: Make Raw Request Action
Config Fields
- Throw Error on 404 Response (Checkbox): Treat
404
HTTP responses as errors.
Input Metadata
- Url (string, required): Path of the resource relative to
resourceServerUrl
. - Method (string enum (
GET
,POST
,PUT
,DELETE
,PATCH
), required): HTTP Verb for the request. - Request Body (object, optional): Body of the request to send
- Request headers (object, optional): Additional HTTP headers to send as part of the request.
Output Metadata
- Status Code (integer, required): HTTP status code of the request
- Response Body (object, optional): JSON representation of the response body from the request
- Response HTTP Headers (object, required): JSON representation of the returned HTTP headers within the request.
OIH Action: Lookup Object (by ID)
Config Fields
- Object Type (dynamic dropdown, required): Provide all
EntitySets
- Unique field to Search On (dynamic dropdown, required): List of all fields for the selected object
- Allow unique field to be omitted (dropdown/checkbox: yes/no); when selected, the unique field becomes optional, otherwise it is a required field
- Allow zero results (dropdown/checkbox: yes/no); When selected, if zero results are returned, the empty object {} is emitted, otherwise typically an error would be thrown.
Input Metadata
- One input for the unique field. Depending on the value of allowIdToBeOmitted this is optional or required.
Output Metadata
- The object as reported by the system
OIH Action Upsert Object
Config Fields
- Object Type (dropdown, required): List of all Entity sets reported in the system.
- ID to Search On (dynamic dropdown, required): List of all fields for the selected object.
Input Metadata
- One input for the search ID. (Optional if selected ID to search on is the Key as per the metadata document)
- Inputs for other fields on the body. All fields that are not nullable and can’t be populated by the system on create should be required.
Output Metadata
- The object post creation/update as reported by the system
OIH Action: Delete Object
Config Fields
- Object Type (dynamic dropdown, required)
Input Metadata
- One input for the Object Key.
Output Metadata
- The id of the object deleted.
Add OIH Action: Lookup Objects (Plural)
Config Fields
- Object Type (dropdown, required): List of all entity sets
- Behavior (dropdown: Fetch All, Fetch Page, Emit Individually, required)
Input Metadata
- Page Size (non-negative integer, optional: defaults to page size used by API): (only if fetch page mode) A value of 0 indicates that the results will be an empty array with only totalCountOfMatchingResults populated.
- Page Number (non-negative 0 based integer, optional: default to 0): (only if fetch page mode)
- Order (Array of fieldname + sort direction pairs, optional: default to empty array): (only if fetch page mode)
- Search Criteria: (optional: default to empty array). Search terms are to be combined with the AND operator. For each search term:
- fieldName
- fieldValue
- e.g. condition (equal, not equal, >=, <=, >, <, like (if supported), whatever else is suppored by the API)
Output Metadata
- For Fetch Page mode:An object with
- key
results
that has an array as its value - key
totalCountOfMatchingResults
which contains the total number of results (not just on the page) which match the search criteria
- key
- For Fetch All mode: An object, with key
results
that has an array as its value. - For Emit Individually mode: Each object should fill the entire message.
OIH Trigger: Get New and Updated Objects Polling
Config Fields
- Object Type (dropdown): List of all entity sets
- Size of Polling Page (optional; positive integer) Indicates the size of pages to be fetched. Defaults to 100.
- Single Page per Interval (dropdown/checkbox: yes/no; default yes) Indicates that if the number of changed records exceeds the maximum number of results in a page, instead of fetching the next page immediately, wait until the next flow start to fetch the next page.
- Time stamp field to poll on (dynamic dropdown). All possible timestamp fields on the selected object
- Emit behavior (dropdown): Emit individually or emit page.
Input Metadata
N/A
Output Metadata
- Array of Items or items individually based on emit behavior.
Add to Component Pusher
DoD
- Add the component to Notion list
- Notify support to update Component Pusher Config