Creating Application API endpoints

Process - Dialog steps

The following is a (general) overview of the steps required when creating an API endpoint. The individual steps correspond to individual dialog steps in Intrexx. Not every step is required for every endpoint.

API endpoints can often be created in a number of ways. For example, sometimes the same result can be achieved with path parameters only, or with a combination of path and query parameters. Consequently, the following overview serves as an orientation on frequently used approaches.

	General In the first dialog step you will be prompted to enter a name and description for the endpoint. The title and description are then used in the Swagger documentation when you create it. In this dialog step, you also select which API endpoint type 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 further dialog steps you will be guided through in the further course of the process; the dialog steps "Path parameters" and "Query parameters" are displayed or run through for all endpoint types. More information on endpoint types can be found in the section Endpoint types.
	Data group, process, or Groovy script selection Depending on which 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 must also specify which method you want to use. The following methods are available for the data-group endpoint: GET, POST, PUT and DELETE. For the process and Groovy endpoints, the PATCH method is also available. For step-by-step instructions on creating data groups, process endpoints, and Groovy script endpoints, see the following sections: Creating data-group endpoints Creating process endpoints Creating Groovy endpoints
	Path parameters You must enter at least one path parameter in the "Path parameters" dialog step. More information on path parameters can be found in the section Defining path parameters.
	Query parameters In the next dialog step you can define query parameters. More information about query parameters can be found in the section Defining query parameters.
	Filters and sorting The "Filters and sorting" dialog step is only displayed if you have selected a data-group endpoint and the "Read multiple data records" action for it. More information on the "Filters and sorting" dialog step can be found in the section Filtering and sorting data records.
	Request JSON-Body The "Request JSON Body" dialog step is displayed if you have selected a data-group or process endpoint and use the POST, PATCH, or PUT methods. More information about Request JSON Body can be found in the section Defining a JSON body.
	Response JSON-Body The "Request JSON Body" dialog step is displayed if you have selected a data-group or process endpoint and use the GET, POST, PATCH, or PUT methods. More information about Response JSON-Body can be found in the section Defining a JSON body.

Overview of the following sections

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

Subsequently, you will find detailed information on the individual dialog steps.