Web Services Guide

10.4.0
- 10.5.7
- 10.5.6
- 10.2.2 Service Pack 1
- 10.2.2
- 10.2.1

Back Next

Request Messages

A web service client sends a request message in a URI string to the web service. The URI identifies the host port, web service name, and the resource to access in a web service. The request message can contain query parameters to filter the web service output for specific rows.

When the URI does not include identifiers or parameters, the REST web service returns a list of all the rows from the data object in the REST web service response. The web service returns a JSON file or an XML file that contains all the customer rows.

The following example shows a request that returns a list of all customers:

http://myhost:8095/DataIntegrationService/RESTSERVICE/Rsrc_CUSTOMER/CUSTOMER

The following text shows a JSON response message:

{"CUSTOMERS": {"CUSTOMER": [
    {
        "C_ACCTBAL": 9331.13,
        "C_ADDRESS": "38 Summit Drive",
        "C_COMMENT": "Call immediately if delay",
        "C_CUSTKEY": {
            "@url": "http:\u002F\u002FHostName:8095\u002FDataIntegrationService\u002FRestService\u002FRsrc_CUSTOMER\u002FCUSTOMER\u002F63",
            "$": 63
    },
        "C_MKTSEGMENT": "AUTOMOBILE",
        "C_NAME": "Customer#000000063",
        "C_NATIONKEY": 21,
        "C_PHONE": "31-952-552-9584" 
    },
    {
        "C_ACCTBAL": -646.64,
        "C_ADDRESS": "44 Ocean Avenue",
        "C_COMMENT": "Has dangerous animal in the house",
        "C_CUSTKEY": {
            "@url": "http:\u002F\u002FHostName:8095\u002FDataIntegrationService\u002FRestService\u002FRsrc_CUSTOMER\u002FCUSTOMER\u002F64",
            "$": 64
        },
        "C_MKTSEGMENT": "BUILDING",
        "C_NAME": "Customer#000000064",
        "C_NATIONKEY": 3,
        "C_PHONE": "13-558-731-7204" 
     }
]}}

REST Web Services

Filter Data in Resource Mappings

Search By Key

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal