Specifications of Web service that can be used as external linkage in IM-BIS¶
Specifications of “Web service” (SOAP/REST) that can used in external linkage functions of IM-BIS .
Contents
Specifications of [REST] URI¶
Any of the following formats can be used in IM-BIS.Setting methods in Web service definition differ as per the delivery format of URI value.
Query storing format (parameter = value)
When using the above format, it should be set to Web service definition request.
Displayed as follows in data mapper.
URI template parameter format {value}
Displayed as follows in data mapper.
Request specifications¶
- The request format specifications of Web service that can be used in IM-BIS are as follows.
Common Request specifications for SOAP/REST¶
Screen items that can be mapped with request parameter are set to hidden parameters of “Input items” and “General items” other than file upload.Note
- Do not use “Non-recommended items” since correct values may not be delivered for them.
- “Common master items”, “Functions”, and “Numbering” can be used when mapping with response.
Specifications of service type “SOAP”¶
Data of “Character string (Varchar)”, “Numerical type (Number)”, “Date type (Date)” and “Logical type (Boolean)” can be used in Web service of SOAP.¶
Data of “Character string (Varchar)”, “Numerical type (Number)”, “Date type (Date)” and “Logical type (Boolean)” can be used in the request parameter of Web service of SOAP.Note that there may be cancellation of significant digits when using decimals for numerical data.Range of numbers that can be used for numerical values of request and response cannot be checked.When you want to guarantee the accuracy of numerical value, store the value in character type item and use after changing the type by function.
In Web service of SOAP, single object cannot be used as parameter.¶
In request in IM-BIS , parameter treating single object as route cannot be used.
Precautions for Web service of SOAP that can be used in IM-BIS .¶
Following are the precautions for linking with Web service of SOAP in IM-BIS .
- In datasource definition of IM-BIS , SOAP encoding, SOAP request Attributes and SOAPFault cannot be supported.
- SOAP response header cannot be used in IM-BIS .
- Parameter not mentioned in WSDL cannot be used.
- WSDL of SOAP cannot be read when it is not closed in one URL.
- Recursive data structure cannot be read in request, response parameter of SOAP.
- Apart from that, format where WSDL cannot be read in datasource definition screen, cannot be supported.
Specifications of service type “REST”¶
In Web service of REST, fixed value or form value can be mapped from data mapper to request header.¶
In the request parameter in Web service of REST, fixed value or value entered in form can be mapped from data mapper for request header.
Response specifications¶
- Specifications related to response format of Web service that can be used in IM-BIS .
Common Response Specifications of SOAP/REST¶
There are no constraints on the hierarchy of response.¶
There are no constraints on the hierarchy of Web service response used in IM-BIS .
Data type should be aligned during mapping of response fields and screen items.¶
Mapping can be set with different data types also, however, it may not operate properly during execution.When mapping different data types, change the response field values such that they are aligned with data type by using data type conversion function.
Response mapping specifications¶
Specifications for the pattern that can be mapped in Web service response are as shown below.
Pattern for single response field
Pattern for response field of array type
| Pattern | Description |
|---|---|
 |
In this pattern, value of response field is reflected in form items. |
 |
In this pattern, value of response field 2 is reflected in first row of column 1 of Detail table.
When there is not a single row, 1 row is added and the value is reflected in the column mapped to the added row.
|
 |
In this pattern, value of first response field is reflected in form item. |
 |
In this pattern, value of response field 2 and 3 is reflected in column 1 and column 2 mapped with Detail table. |
 |
Fields included in the array with different responses cannot be mapped with the column of same Detail table. |
Note
When using SOAP in external linkage of IM-BIS , it may not operate normally due to constraints based on current specifications of Apache Axis2.
When customer uses SOAP by developing Web service it is recommended to use in REST.