Process Management

AX Semantics

7min

The AX Semantics modules allow you to monitor, create, update, send, retrieve, list, and delete the documents from your AX Semantics account.
To get started with AX Semantics, you need to have an AX Semantics account.
The module dialog fields that are displayed in bold (in the Make Make, not in this documentation article) are mandatory!
Connecting AX Semantics to ﻿ 
To connect your AX Semantics account to Make you need to obtain the Refresh Token from your AX Semantics account and insert it in the Create a connection dialog in the Make module.
Log in to your AX Semantics account.
Click API Access.
Copy the Refresh Token to your clipboard.
Log in to your Make account, add a module from the AX Semantics app into an Make scenario.
Click Add next to the Connection field.
In the Connection name field, enter a name for the connection.
In the Refresh Token field, enter the token details copied in step 3 and click Continue.
The connection has been established.
Triggers
Triggers when new content is generated.
Webhook Name
Enter a name for the webhook.
Connection
﻿Establish a connection to your AX Semantics account.
See the Setting Up AX Semantics Webhooks ﻿to add webhooks in your AX Semantics account.
﻿
Actions
Uploads your data.
Connection
﻿Establish a connection to your AX Semantics account.
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.
Connection
﻿Establish a connection to your AX Semantics account.
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.
Deletes a document.
Connection
﻿Establish a connection to your AX Semantics account.
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.
﻿
Shows details of a document.
Connection
﻿Establish a connection to your AX Semantics account.
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.
Performs an arbitrary authorized API call.
Connection
﻿Establish a connection to your AX Semantics account.
URL
Enter a path relative to https://api.ax-semantics.com
For example: /v3/documents/
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.
For the list of available endpoints, refer to the AX Semantics API Documentation.
Searches
Search documents by given criteria.
Connection
﻿Establish a connection to your AX Semantics account.
Collection ID
Select or map the Collection ID whose documents you want to search.
Processing State
Select or map the document processing status:
Generated
Requested
Delivered
None
Ordering
Select or map the order to arrange the documents:
Newest changes first
Oldest changes first
Modified Before
Enter (map) the date to search the documents that were modified on or before the specified date. See the list of supported date and time formats﻿.
Modified Since
Enter (map) the date to search the documents that were modified on or after the specified date. See the list of supported date and time formats﻿.
Limit
Set the maximum number of results Make should return during one execution cycle.
﻿
Search Documents
Open the Watch Generated Content module, enter a name for the webhook, click Save, and copy the URL address to your clipboard. Click OK and save the trigger.
61f2669820854.gif
﻿
Log in to your AX Semantics account.
Click the Project in which you want to add the webhook.
61f2669acc99e.png
﻿
Click the Settings button.
61f2669be5cc0.png
﻿
Click Instant Generation Endpoints.
61f2669d22059.png
﻿
Click Create a New Instant Generation Endpoint and enter the URL address copied in step 1.

Webhook Name	Enter a name for the webhook.
Connection	Establish a connection to your AX Semantics account.

Connection	Establish a connection to your AX Semantics account.
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.

Connection	Establish a connection to your AX Semantics account.
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.

Connection	Establish a connection to your AX Semantics account.
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.

Connection	Establish a connection to your AX Semantics account.
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.

Connection	Establish a connection to your AX Semantics account.
URL	Enter a path relative to https://api.ax-semantics.com For example: /v3/documents/
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.

Connection	Establish a connection to your AX Semantics account.
Collection ID	Select or map the Collection ID whose documents you want to search.
Processing State	Select or map the document processing status: Generated Requested Delivered None
Ordering	Select or map the order to arrange the documents: Newest changes first Oldest changes first
Modified Before	Enter (map) the date to search the documents that were modified on or before the specified date. See the list of supported date and time formats.
Modified Since	Enter (map) the date to search the documents that were modified on or after the specified date. See the list of supported date and time formats.
Limit	Set the maximum number of results Make should return during one execution cycle.