REST API Reference

Back Next

services

Use the services resource to run industry data services using Informatica Intelligent Cloud Services REST API.

Industry data services refer to a collection of pre-built data services designed to parse, validate, and serialize industry-specific data standards. These data services are available on the data service repository and you can use REST APIs to run them.

When you use the services resource, use the following request header format:

<METHOD><base URL>
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>

POST request

To run a data service, use the following URI:

/DSRepo/rest/api/v1/services/run/<service name>

Include the following fields in the request:

Field	Type	Required	Description
agentGroupId	String	Yes	ID of the Secure agent group to process the request.
input			Default input port for the data service.
type	string	Yes	Whether the input is a file or data. Use one of the following values: FILE: Input is a file. BUFFER: Input is data.
value	string	Yes	Value of the input type. If the type is FILE, value of the input file path. If the type is BUFFER, the value is a text string.
output			Default output port for the data service.
type	String	Yes	Whether the output is provided as data or saved to a target file path. Use one of the following values: FILE: Output is saved to a target file. BUFFER: Output is provided data.
value	String	Required when type is FILE	Value of the output file path.
additionalInputs	Array		Additional input ports for the data service.
name	String		Name of the additional input port.
type	String		Whether the additional input is a file or data. Use one of the following values: FILE: Input is a file. BUFFER: Input is data.
value	String		Value of the additional input type. If the type is FILE, the value of the input file path. If the type is BUFFER, the value is a text string.
additionalOutputs	Array	Required for some data services.	Additional output ports for the data service. For HL7, provide the following additional outputs: Errors ErrorsFound . For HIPPA, provide the following additional outputs: Errors ErrorsFound ValidationReport
name	String	Yes	Name of the additional output port.
type	String	Yes	Whether the additional output is provided data or saved to a target file path. Use one of the following values: FILE: Output is saved to a target file. BUFFER: Output is provided as data.
value	String	Required when type is FILE	Value of the additional output file path.
serviceParameters	Array		Variables in the service parameter ports.
name	String		Name of the service parameter.
value	String		Value of the service parameter.

POST request example

To run an HL7 data service, you might send a request similar to the following example:


POST <serverUrl>/DSRepo/rest/api/v1/services/run/HL7_2_6_ADT_A01_Parser
Content-Type: application/json
Accept:application/json
IDS-SESSION-ID:2l0oeVx22Rujiej7yTokmT
{    
	"agentGroupId": "010BM02500000000000K",    
	"input": {        
		"type": "FILE",        
		"value": "/root/TEST/v25_s2.txt"    
	},    
	"output": {        
		"type": "FILE",        
		"value":"/root/TEST/"    
	},    
	"additionalInputs": [],    
	"serviceParameters": [],    
	"additionalOutputs": [        
		{            
			"name": "Errors",            
			"type": "FILE",
			"value":"/root/TEST/"                   
		},        
		{            
			"name": "ErrorsFound",            
			"type": "FILE",
			"value":"/root/TEST/"                    
		}    
	]    
}

POST response

When you use a POST request to run a data service, it returns a success response if successful or an error object if an error occurs. If the request is unsuccessful, the response includes a reason for the failure.

POST response example

If the request is successful, you might receive a response similar to the following example:


{    
	"output": "/root/TEST/HL7_2_6_ADT_A01_Parser_output.xml",
	"additionalOutputs": [
  {            
			"type": "file",            
			"value": "/root/TEST/HL7_2_6_ADT_A01_Parser_Errors.xml",            
			"name": "Errors"        
		},        
		{            
			"type": "file",            
			"value": "/root/TEST/HL7_2_6_ADT_A01_Parser_ErrorsFound.xml",            
			"name": "ErrorsFound"        
		}    
	],    
	"message": "Success"
}

Data Integration REST API

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage