AX Semantics modules
After connecting to the AX Semantics app, you can use the following modules to build your .
Triggers when new content is generated.
Field | Description |
|---|---|
Webhook Name | Enter a name for the webhook. |
Connection |
See the Setting Up AX Semantics Webhooks to add webhooks in your AX Semantics account.
Uploads your data.
Field | Description |
|---|---|
Connection | |
Collection ID | Select or map the Collection ID of the document. |
Document Data | Enter (map) the document data in the JSON format to publish the content in your collection. You can provide either a name and/or UID parameters that help to find your document easily. |
Updates an existing document.
Field | Description |
|---|---|
Connection | |
Collection ID | Select or map the collection ID of the document which you want to update. |
Document ID | Select or map the Document ID whose details you want to update. |
Document Data | Enter (map) the document data in the JSON format to publish the content in your collection. You can provide either a name and/or UID parameters that help to find your document easily. |
Shows details of a document.
Field | Description |
|---|---|
Connection | |
Collection ID | Select or map the Collection ID whose document details you want to retrieve. |
Document ID | Select or map the Document ID whose details you want to retrieve. |
Deletes a document.
Field | Description |
|---|---|
Connection | |
Collection ID | Select or map the Collection ID whose document you want to delete. |
Document ID | Select or map the Document ID you want to delete. |
Performs an arbitrary authorized API call.
Field | Description |
|---|---|
Connection | |
URL | Enter a path relative to https://api.ax-semantics.com For example: /v3/documents/ For the list of available endpoints, refer to the AX Semantics API Documentation. |
Method | Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String | Enter the request query string. |
Body | Enter the body content for your API call. |
The following API call returns all the collections from your AX Semantics account:
URL:
/v3/collections/
Method:
GET
Matches of the search can be found in the module's Output under Bundle > Body > results.
In our example, 104 collections were returned:
Search documents by given criteria.
Field | Description |
|---|---|
Connection | |
Collection ID | Select or map the Collection ID whose documents you want to search. |
Processing State | Select or map the document processing status:
|
Ordering | Select or map the order to arrange the documents:
|
Modified Before | Enter (map) the date to search the documents that were modified on or before the specified date. |
Modified Since | Enter (map) the date to search the documents that were modified on or after the specified date. |
Limit | Set the maximum number of results should return during one execution cycle. |