Calling Web Services via Curl - Revision history

Vmurrell at 09:14, 19 July 2023

2023-07-19T09:14:34Z

2023-02-07T14:02:46Z

‎Combining UNIX commands

2023-02-07T14:02:05Z

‎Example Use of Curl

2023-02-07T13:58:27Z

‎Use of Curl

2023-02-07T13:58:19Z

‎Use of Curl

2023-02-07T13:57:42Z

‎Use of Curl

2023-02-07T13:57:27Z

‎Use of Curl

2023-02-07T13:57:17Z

‎Use of Curl

2023-02-07T13:54:11Z

‎Use of Curl

2023-02-07T13:50:53Z

‎Use of Curl

← Older revision		Revision as of 09:14, 19 July 2023
Line 1:		Line 1:
		+	[[Category:How_To V11]]
		+	[[Category:FMR_REST_API_Reference]]
	Rather than using the Graphical User Interface, the Fusion Metadata Registry can perform operations by calling its Web Services. Examples of these are the [[Data_Validation_Web_Service \| Data Validation]] and [[Data_Transformation_Web_Service \| Data Transformation]] Web Services. These can be invoked by a tool such as Postman, but this page aims to give some guidance on using the UNIX tool "curl" to invoke these Web Services.		Rather than using the Graphical User Interface, the Fusion Metadata Registry can perform operations by calling its Web Services. Examples of these are the [[Data_Validation_Web_Service \| Data Validation]] and [[Data_Transformation_Web_Service \| Data Transformation]] Web Services. These can be invoked by a tool such as Postman, but this page aims to give some guidance on using the UNIX tool "curl" to invoke these Web Services.

@@ Line 31: / Line 31: @@
 Since CURL is a standard UNIX command it can be combined with other commands to perform more complicated tasks and is especially useful in performing batch operations.
-A simple example of this is using CAT as the input can be performed by stating the input is "@-".  An example follows showing how "cat"ing a SDMX JSON file and piping the output into the CURL command:
+A simple example of this is using CAT as the input can be performed by stating the input is "@-".  An example follows showing how "cat"ing a SDMX JSON file and piping the output into the CURL command to submit the structure file to the Registry.  This example also shows passing in a userid and password:
 <pre>

← Older revision		Revision as of 14:02, 7 February 2023
Line 26:		Line 26:
	=== Use of data-binary ===		=== Use of data-binary ===
	It is highly recommended to specify your file with the "--data-binary" option. Curl's -d option will strip out newline characters so is fine when validating / transforming XML but not for when you are processing CSV or Microsoft Excel files.		It is highly recommended to specify your file with the "--data-binary" option. Curl's -d option will strip out newline characters so is fine when validating / transforming XML but not for when you are processing CSV or Microsoft Excel files.
		+
		+	=== Combining UNIX commands ===
		+
		+	Since CURL is a standard UNIX command it can be combined with other commands to perform more complicated tasks and is especially useful in performing batch operations.
		+
		+	A simple example of this is using CAT as the input can be performed by stating the input is "@-". An example follows showing how "cat"ing a SDMX JSON file and piping the output into the CURL command:
		+
		+	<pre>
		+	cat SimpleCodelist.json \|
		+	curl -X POST
		+	--user root:password
		+	--header "Content-Type: application/json"
		+	--data-binary @-
		+	http://localhost:8080/FusionRegistry/ws/secure/sdmxapi/rest
		+	<pre>

@@ Line 1: / Line 1: @@
 Rather than using the Graphical User Interface, the Fusion Metadata Registry can perform operations by calling its Web Services. Examples of these are the [[Data_Validation_Web_Service | Data Validation]] and [[Data_Transformation_Web_Service | Data Transformation]] Web Services. These can be invoked by a tool such as Postman, but this page aims to give some guidance on using the UNIX tool "curl" to invoke these Web Services.
-== Use of Curl ==
+== Example Use of Curl ==
 The following shows an example use of curl to the Fusion Metadata Registry.

@@ Line 17: / Line 17: @@
 The above specifies:
 * curl is performing a POST operation
-* The Header parameter of Content-Type is set to application/text
+* The Header parameter of "Content-Type" is set to application/text
-* The Header parameter of "Accept is set to output in SDMX-ML Structure Specific 2.1 form
+* The Header parameter of "Accept" is set to output in SDMX-ML Structure Specific 2.1 form
 * The input file is an SDMX-CSV input file called "My Input File.csv"
 * The Registry is accessible at:  http://localhost:8080/FusionRegistry  and the transform Web Service is : /ws/public/data/transform

@@ Line 3: / Line 3: @@
 == Use of Curl ==
-An example showing a call to transform an SDMX-CSV input file "My Input File.csv" into SDMX-ML version 2.1.  The output is redirected into the output file "Generated.xml"
+The following shows an example use of curl to the Fusion Metadata Registry.
 <pre>
    curl -X POST
      --header "Content-Type:application/text"
      --header "Structure:urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=OECD:DF_BATIS_EBOPS2010(1.0)"
      --data-binary "@My Input File.csv"
      http://localhost:8080/FusionRegistry/ws/public/data/transform
      > Generated.xml
 </pre>
 === Use of data-binary ===
 It is highly recommended to specify your file with the "--data-binary" option.  Curl's -d option will strip out newline characters so is fine when validating / transforming XML but not for when you are processing CSV or Microsoft Excel files.

← Older revision		Revision as of 13:54, 7 February 2023
Line 14:		Line 14:
	> Generated.xml		> Generated.xml
	</pre>		</pre>
		+
		+	=== Use of data-binary ===
		+	It is highly recommended to specify your file with the "--data-binary" option. Curl's -d option will strip out newline characters so is fine when validating / transforming XML but not for when you are processing CSV or Microsoft Excel files.