Integration/REST - Revision history

Tvi: /* Version 2 (Json) */ Swagger UI

2024-05-30T12:04:57Z

Version 2 (Json): Swagger UI

← Older revision		Revision as of 14:04, 30 May 2024
Line 78:		Line 78:
	</syntaxhighlight>		</syntaxhighlight>

	You can ~~upload~~ the ~~content to this site to browse it: [https~~:~~//editor.swagger.io/ SwaggerIO Editor]~~		You can browse and try the api, using the built in SwaggerUI (from version 9147):

			<syntaxhighlight lang="ini">
			https://<server>/<application>/rest/v2/swagger
			</syntaxhighlight>

	== URL structure ==		== URL structure ==

Tvi at 12:40, 13 May 2024

2024-05-13T12:40:37Z

← Older revision		Revision as of 14:40, 13 May 2024
Line 1:		Line 1:
	== Introduction to the REST interface ==		== Introduction to the REST interface ==

	~~This article has not yet been fully converted to Wiki format.~~

	~~Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]~~

	The rest interface has two versions.		The rest interface has two versions.
Line 11:		Line 7:

	== Version 1 (XML) ==		== Version 1 (XML) ==

			This article has not yet been fully converted to Wiki format.

			Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]

	=== Netbeans quick start guide ===		=== Netbeans quick start guide ===

Tvi: Info about v2

2024-05-13T12:38:03Z

Info about v2

← Older revision		Revision as of 14:38, 13 May 2024
Line 1:		Line 1:
	== Introduction to the REST interface ==		== Introduction to the REST interface ==

	This article has not yet been fully converted to Wiki format.		This article has not yet been fully converted to Wiki format.

Line 9:		Line 10:


	== Version 1 ==		== Version 1 (XML) ==

	=== Netbeans quick start guide ===		=== Netbeans quick start guide ===
Line 67:		Line 68:
	session.close();		session.close();
	</syntaxhighlight>		</syntaxhighlight>


			== Version 2 (Json) ==

			Download the swagger file from:

			<syntaxhighlight lang="ini">
			https://<server>/<application>/rest/v2/swagger.json
			</syntaxhighlight>

			You can upload the content to this site to browse it: [https://editor.swagger.io/ SwaggerIO Editor]


	== URL structure ==		== URL structure ==

	When logged in the following URLs are available without further authentication		When logged in the following URLs are available without further authentication

Line 74:		Line 88:

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	~~https~~://<server>/<application>/rest/<version>/<~~solution~~>		http(s)://<server>/<application>/rest/<version>/<entity>
	</syntaxhighlight>		</syntaxhighlight>

Line 80:		Line 94:

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	~~https~~://<server>/<application>/rest/<version>/<~~solution~~>/<DataID>		http(s)://<server>/<application>/rest/<version>/<entity>/<DataID>
	</syntaxhighlight>		</syntaxhighlight>

	~~'''Note: The fowllowing file handling endpoints are scheduled for Q2 2020'''~~

	File list operations: PUT, POST		File list operations: PUT, POST

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	~~https~~://<server>/<application>/rest/<version>/<~~solution~~>/<DataID>/<FieldName>/		http(s)://<server>/<application>/rest/<version>/<entity>/<DataID>/<FieldName>/
	</syntaxhighlight>		</syntaxhighlight>

Line 94:		Line 106:

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	~~https~~://<server>/<application>/rest/<version>/<~~solution~~>/<DataID>/<FieldName>/<FileName>		http(s)://<server>/<application>/rest/<version>/<entity>/<DataID>/<FieldName>/<FileName>
			</syntaxhighlight>

			=== Executing codeunit ===

			Operations: GET, PUT, POST, DELETE

			<syntaxhighlight lang="ini">
			http(s)://<server>/<application>/rest/<version>/codeunit/<codeunitName>
	</syntaxhighlight>		</syntaxhighlight>

Tvi: Notet version changes and new endpoints

2024-05-13T09:56:30Z

Notet version changes and new endpoints

← Older revision		Revision as of 11:56, 13 May 2024
Line 4:		Line 4:
	Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]		Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]

			The rest interface has two versions.
			* v1, XML-version (default)
			* v2, JSON-version

	== Netbeans quick start guide ==
			== Version 1 ==

			=== Netbeans quick start guide ===

	Steps to create a simple interaction		Steps to create a simple interaction
Line 65:		Line 71:
	When logged in the following URLs are available without further authentication		When logged in the following URLs are available without further authentication

	Data list operations: GET, PUT		Data list operations: GET, PUT, POST

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	https://<server>/<application>/rest/<solution>		https://<server>/<application>/rest/<version>/<solution>
	</syntaxhighlight>		</syntaxhighlight>

	Data item operations: GET, POST		Data item operations: GET, PUT, POST, DELETE

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	https://<server>/<application>/rest/<solution>/<DataID>		https://<server>/<application>/rest/<version>/<solution>/<DataID>
	</syntaxhighlight>		</syntaxhighlight>

	'''Note: The fowllowing file handling endpoints are scheduled for Q2 2020'''		'''Note: The fowllowing file handling endpoints are scheduled for Q2 2020'''

	File list operations: ~~GET~~, ~~PUT~~		File list operations: PUT, POST

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	https://<server>/<application>/rest/<solution>/<DataID>/<FieldName>/		https://<server>/<application>/rest/<version>/<solution>/<DataID>/<FieldName>/
	</syntaxhighlight>		</syntaxhighlight>

	File item operations: GET		File item operations: GET, PUT, POST, DELETE

	<syntaxhighlight lang="ini">		<syntaxhighlight lang="ini">
	https://<server>/<application>/rest/<solution>/<DataID>/<FieldName>/<ID>		https://<server>/<application>/rest/<version>/<solution>/<DataID>/<FieldName>/<FileName>
	</syntaxhighlight>		</syntaxhighlight>

Tvi at 09:15, 22 April 2024

2024-04-22T09:15:17Z

← Older revision	Revision as of 11:15, 22 April 2024
Line 1:	Line 1:
		== Introduction to the REST interface ==
		This article has not yet been fully converted to Wiki format.

		Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]


		== Netbeans quick start guide ==

		Steps to create a simple interaction
		# Add Webservice to ide (wadl import)
		#* URL: [ServerName]/[ApplicationName]/rest/[SolutionSystemName].wadl
		#* If import causes trouble: Download the wadl file
		# Create a new project
		## Add REST Client to project
		##* Point to newly created webservice: [SolutionSystemName]
		## Add JAXB bindings to project (use XSD schema)
		##* URL: [ServerName]/[ApplicationName]/rest/[SolutionSystemName].xsd
		##* If import causes trouble: Download the xsd file


		==== Sample code for list view (BASIC athentication) ====

		<syntaxhighlight lang="java">
		//Create session
		FirmabilerClient session = new FirmabilerClient();
		session.setUsernamePassword("admin", "password1223");

		//Set search parameters (first parameter is a dummy)
		FirmabilerList result = session.getList(FirmabilerList.class, "", "TITEL=Kasper" );

		//Retrieve data and print
		List <FirmabilerListItem> list = result.getFirmabilerListItem();
		for(int i=0; i<list.size(); i++) {
		//Handle single item
		FirmabilerListItem item = list.get(i);
		System.out.println( item.getDataID() + "\t" + item.getNUMMERPLADE() );
		}

		//Close connection
		session.close();
		</syntaxhighlight>

		==== Sample code for list view (parameter credentials) ====

		<syntaxhighlight lang="java">
		//Create session
		FirmabilerClient session = new FirmabilerClient();

		//Login and set search parameters
		FirmabilerList result = session.getList(FirmabilerList.class, "admin", "password1223", "TITEL=Kasper" );

		//Retrieve data and print
		List <FirmabilerListItem> list = result.getFirmabilerListItem();
		for(int i=0; i<list.size(); i++) {
		//Handle single item
		FirmabilerListItem item = list.get(i);
		System.out.println( item.getDataID() + "\t" + item.getNUMMERPLADE() );
		}

		//Close connection
		session.close();
		</syntaxhighlight>

		== URL structure ==
		When logged in the following URLs are available without further authentication

		Data list operations: GET, PUT

		<syntaxhighlight lang="ini">
		https://<server>/<application>/rest/<solution>
		</syntaxhighlight>

		Data item operations: GET, POST

		<syntaxhighlight lang="ini">
		https://<server>/<application>/rest/<solution>/<DataID>
		</syntaxhighlight>

		'''Note: The fowllowing file handling endpoints are scheduled for Q2 2020'''

		File list operations: GET, PUT

		<syntaxhighlight lang="ini">
		https://<server>/<application>/rest/<solution>/<DataID>/<FieldName>/
		</syntaxhighlight>

		File item operations: GET

		<syntaxhighlight lang="ini">
		https://<server>/<application>/rest/<solution>/<DataID>/<FieldName>/<ID>
		</syntaxhighlight>

		=== Query parameters ===

		The REST API supports the same filtering and search parameters, as the list-command [[Integration/Content_source]].

Tvi: Blanked the page

2024-04-22T09:04:55Z

Blanked the page

← Older revision		Revision as of 11:04, 22 April 2024
Line 1:		Line 1:


	~~=== Query parameters ===~~

	~~The REST API supports the same filtering and search parameters, as the list-command [[Integration/Content_source]].~~

Tvi: Replaced content with " === Query parameters === The REST API supports the same filtering and search parameters, as the list-command Integration/Content_source."

2024-04-22T09:04:38Z

Replaced content with " === Query parameters === The REST API supports the same filtering and search parameters, as the list-command Integration/Content_source."

← Older revision		Revision as of 11:04, 22 April 2024
Line 1:		Line 1:
	~~== Introduction to the REST interface ==~~
	~~This article has not yet been fully converted to Wiki format.~~

	~~Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]~~


	~~== Netbeans quick start guide ==~~

	~~Steps to create a simple interaction~~
	~~# Add Webservice to ide (wadl import)~~
	~~#* URL: [ServerName]/[ApplicationName]/rest/[SolutionSystemName].wadl~~
	~~#* If import causes trouble: Download the wadl file~~
	~~# Create a new project~~
	~~## Add REST Client to project~~
	~~##* Point to newly created webservice: [SolutionSystemName]~~
	~~## Add JAXB bindings to project (use XSD schema)~~
	~~##* URL: [ServerName]/[ApplicationName]/rest/[SolutionSystemName].xsd~~
	~~##* If import causes trouble: Download the xsd file~~


	~~==== Sample code for list view (BASIC athentication) ====~~

	~~<syntaxhighlight lang="java">~~
	~~//Create session~~
	~~FirmabilerClient session = new FirmabilerClient();~~
	~~session.setUsernamePassword("admin", "password1223");~~

	~~//Set search parameters (first parameter is a dummy)~~
	~~FirmabilerList result = session.getList(FirmabilerList.class, "", "TITEL=Kasper" );~~

	~~//Retrieve data and print~~
	~~List <FirmabilerListItem> list = result.getFirmabilerListItem();~~
	~~for(int i=0; i<list.size(); i++) {~~
	~~//Handle single item~~
	~~FirmabilerListItem item = list.get(i);~~
	~~System.out.println( item.getDataID() + "\t" + item.getNUMMERPLADE() );~~
	}

	~~//Close connection~~
	~~session.close();~~
	~~</syntaxhighlight>~~

	~~==== Sample code for list view (parameter credentials) ====~~

	~~<syntaxhighlight lang="java">~~
	~~//Create session~~
	~~FirmabilerClient session = new FirmabilerClient();~~

	~~//Login and set search parameters~~
	~~FirmabilerList result = session.getList(FirmabilerList.class, "admin", "password1223", "TITEL=Kasper" );~~

	~~//Retrieve data and print~~
	~~List <FirmabilerListItem> list = result.getFirmabilerListItem();~~
	~~for(int i=0; i<list.size(); i++) {~~
	~~//Handle single item~~
	~~FirmabilerListItem item = list.get(i);~~
	~~System.out.println( item.getDataID() + "\t" + item.getNUMMERPLADE() );~~
	}

	~~//Close connection~~
	~~session.close();~~
	~~</syntaxhighlight>~~

	=== Query parameters ===		=== Query parameters ===

	The REST API supports the same filtering and search parameters, as the list-command [[Integration/Content_source]].		The REST API supports the same filtering and search parameters, as the list-command [[Integration/Content_source]].

Tvi at 09:04, 22 April 2024

2024-04-22T09:04:14Z

@@ Line 4: / Line 4: @@
 Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]
@@ Line 47: / Line 60: @@
 //Close connection
 session.close();
 </syntaxhighlight>

Tvi at 09:03, 22 April 2024

2024-04-22T09:03:39Z

← Older revision		Revision as of 11:03, 22 April 2024
Line 2:		Line 2:
	This article has not yet been fully converted to Wiki format.		This article has not yet been fully converted to Wiki format.

			Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]

	~~== Netbeans quick start guide ==~~

	~~Steps to create a simple interaction~~
	~~# Add Webservice to ide (wadl import)~~
	~~#* URL: [ServerName]/[ApplicationName]/rest/[SolutionSystemName].wadl~~
	~~#* If import causes trouble: Download the wadl file~~
	~~# Create a new project~~
	~~## Add REST Client to project~~
	~~##* Point to newly created webservice: [SolutionSystemName]~~
	~~## Add JAXB bindings to project (use XSD schema)~~
	~~##* URL: [ServerName]/[ApplicationName]/rest/[SolutionSystemName].xsd~~
	~~##* If import causes trouble: Download the xsd file~~

Tvi at 09:03, 22 April 2024

2024-04-22T09:03:18Z

← Older revision		Revision as of 11:03, 22 April 2024
Line 1:		Line 1:
	== Introduction to the REST interface ==		== Introduction to the REST interface ==
	This article has not yet been fully converted to Wiki format.		This article has not yet been fully converted to Wiki format.

	~~Please download the original article: [http://www.tempusserva.dk/articlebase/Tempus%20Serva%20REST%20interface.pdf Tempus Serva REST interface.pdf]~~