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 {{product name}} 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 watch generated content 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 docid 1j5e5cwhh5 7kccpjq8 9 to add webhooks in your ax semantics account actions add a document 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 update a document 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 delete a document 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 make an api call 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 https //developers ax semantics com/ searches search documents 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 docid\ sqitts xzcflfg9j6xyui 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 docid\ sqitts xzcflfg9j6xyui limit set the maximum number of results make should return during one execution cycle search documents setting up ax semantics webhooks 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 log in to your ax semantics account click the project in which you want to add the webhook click the settings button click instant generation endpoints click create a new instant generation endpoint and enter the url address copied in step 1