Create Application API Endpoints

Process - Dialog Steps

Below is a (general) overview of the individual steps you need to follow when creating an API endpoint. Each of these steps corresponds to a specific dialog step in Intrexx. Not every step is required for every endpoint.

API endpoints can often be created in various ways. For example, sometimes the same result can be achieved using only path parameters, while other times it can be achieved using a combination of path and query parameters. Therefore, the following overview provides guidance on commonly used procedures.

	General In the first step of the dialog, you will be prompted to enter a name and a description for the endpoint. The title and description will be included in the Swagger documentation when you generate it. In this dialog step, you also select the type of API endpoint you want to create. The following endpoint types are available: Data Group Endpoint Process Endpoint Groovy Endpoint The selection of the endpoint type also determines which additional dialog steps you will be guided through as you proceed; the "Path Parameters" and "Query Parameters" dialog steps are displayed or walked through for all endpoint types. For more information on endpoint types, see the " Endpoint Types" section.
	Data Group, Process, and Groovy Script Selection Depending on the endpoint type you selected in the "General" dialog step, you must select either the desired data group, the desired process, or the desired Groovy script in the next step. In this dialog step, you also specify which method you want to use. The following methods are available for the data group endpoint: GET, POST, PUT, and DELETE. The PATCH method is also available for the Process and Groovy endpoints. Step-by-step instructions for creating data groups, process endpoints, and Groovy script endpoints can be found in the following sections: Create Data Group Endpoints Create a Process Endpoint Create a Groovy endpoint
	Path Parameters In the "Path Parameter" dialog step, you must enter at least one path parameter. For more information on path parameters, see the section " Define Path Parameters."
	Query Parameters In the next dialog step, you can define query parameters. For more information on query parameters, see the section " Define Query Parameters."
	Filters and Sorting The "Filter and Sort" dialog step appears only if you have selected a data group endpoint and the "Read Multiple Records" action. For more information on the "Filter and Sort" dialog step, see the section " Filter and Sort Records."
	Request JSON Body The "Request JSON Body" dialog step appears when you have selected a data group or process endpoint and are using the POST, PATCH, or PUT methods. For more information on the request JSON body, see the section " Define the JSON body."
	Response JSON Body The "Request JSON Body" dialog step appears when you have selected a data group or process endpoint and are using the GET, POST, PATCH, or PUT methods. For more information on the response JSON body, see the section " Define the JSON body."

Overview of the Following Sections

The following sections will first provide you with some general information about the three different endpoint types and the structure of the API URL.

Below, you'll find detailed information about each step in the dialog.