Obtaining Request Definitions
Each of the three Cantara web services have pre-defined parameters. You lookup these parameters manually using the Cantara Administration Console or use additional web services that are available to obtain a definition of a request.
When you use the HTTP GET method you are able to consume these additional web services. The base URL for the request is http://hostname:port/cantara/service/{service-name}/{name}, where '{service-name}' refers to the service you want to call (function,query, and report) and '{name}' refers to name of the function, report or query for which you want to obtain the definition.
The following are examples showing how to use this service.
Get Function Definition - GetAddressInformation
Endpoint: http://hostname:port/cantara/service/function/GetAddressInformation
Request-Method: GET
Response-Payload
JS
{
"FunctionParameter": [
{
"name": "addressNo",
"jdeName": "mnAddressNumber",
"dataType": "INTEGER",
"direction": "BOTH",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 8,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "costCenter",
"jdeName": "szCostCenter",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 12,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "addressLine",
"jdeName": "szAddressLine1",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 40,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "addressLine2",
"jdeName": "szAddressLine2",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 40,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "city",
"jdeName": "szCity",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 25,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "state",
"jdeName": "szState",
"dataType": "UDC",
"direction": "OUT",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 3,
"displayDecimals": 0,
"udcProductCode": "00",
"udcRecordType": "S"
},
{
"name": "zipCode",
"jdeName": "szZipCodePostal",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 12,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "country",
"jdeName": "szCountry",
"dataType": "UDC",
"direction": "OUT",
"inclusion": "OPTIONAL",
"lookup": false,
"defaultValue": "",
"length": 3,
"displayDecimals": 0,
"udcProductCode": "00",
"udcRecordType": "CN"
},
{
"name": "szProgramId",
"jdeName": "szProgramId",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "HIDDEN",
"lookup": false,
"defaultValue": "",
"length": 10,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "szUserId",
"jdeName": "szUserId",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "HIDDEN",
"lookup": false,
"defaultValue": "",
"length": 10,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "szWorkStationId",
"jdeName": "szWorkStationId",
"dataType": "STRING",
"direction": "OUT",
"inclusion": "HIDDEN",
"lookup": false,
"defaultValue": "",
"length": 10,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "jdDateUpdated",
"jdeName": "jdDateUpdated",
"dataType": "DATE",
"direction": "OUT",
"inclusion": "HIDDEN",
"lookup": false,
"defaultValue": "",
"length": 6,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "mnTimeLastUpdated",
"jdeName": "mnTimeLastUpdated",
"dataType": "INTEGER",
"direction": "OUT",
"inclusion": "HIDDEN",
"lookup": false,
"defaultValue": "",
"length": 6,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "cSuppressErrorMessage",
"jdeName": "cSuppressErrorMessage",
"dataType": "CHARACTER",
"direction": "IN",
"inclusion": "HIDDEN",
"lookup": true,
"defaultValue": "1",
"length": 1,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "cErrorFlag",
"jdeName": "cErrorFlag",
"dataType": "CHARACTER",
"direction": "BOTH",
"inclusion": "HIDDEN",
"lookup": false,
"defaultValue": "",
"length": 1,
"displayDecimals": 0,
"udcProductCode": "",
"udcRecordType": ""
}
],
"name": "GetAddressInformation",
"jdeName": "F0101GetAddressInformation",
"locked": true,
"cantaraVersion": "4.1"
}Get Query Definition - GetUDCList
Endpoint: http://hostname:port/cantara/service/query/GetUDCList
Request-Method: GET
Response-Payload
JS
{
"Select": {
"QueryParameter": [
{
"name": "productCode",
"alias": "SY",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "UDC",
"hidden": false,
"lookup": false,
"length": 4,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "98",
"udcRecordType": "SY"
},
{
"name": "recordType",
"alias": "RT",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": false,
"lookup": false,
"length": 2,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "key",
"alias": "KY",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": false,
"lookup": false,
"length": 10,
"displayDecimals": 0,
"sortDirection": "ASCENDING",
"sortSequence": 1,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "description1",
"alias": "DL01",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": false,
"lookup": false,
"length": 30,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "description2",
"alias": "DL02",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": false,
"lookup": false,
"length": 30,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "specialHandling",
"alias": "SPHD",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": false,
"lookup": false,
"length": 10,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "udcOwnership",
"alias": "UDCO",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "UDC",
"hidden": false,
"lookup": false,
"length": 1,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "H98",
"udcRecordType": "UD"
},
{
"name": "hardCoded",
"alias": "HRDC",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "CHARACTER",
"hidden": false,
"lookup": false,
"length": 1,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "UserId",
"alias": "USER",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": true,
"lookup": false,
"length": 10,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "ProgramId",
"alias": "PID",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": true,
"lookup": false,
"length": 10,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "DateUpdated",
"alias": "UPMJ",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "DATE",
"hidden": true,
"lookup": false,
"length": 6,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "WorkStationId",
"alias": "JOBN",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "STRING",
"hidden": true,
"lookup": false,
"length": 10,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
},
{
"name": "TimeLastUpdated",
"alias": "UPMT",
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"dataType": "INTEGER",
"hidden": true,
"lookup": false,
"length": 6,
"displayDecimals": 0,
"sortDirection": "NONE",
"sortSequence": 0,
"udcProductCode": "",
"udcRecordType": ""
}
]
},
"Filter": [
{
"QueryColumn": {
"name": "productCode",
"alias": "SY",
"dataType": "UDC",
"length": 4,
"displayDecimals": 0,
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"hidden": false,
"udcProductCode": "98",
"udcRecordType": "SY"
},
"Literal": [
""
],
"operator": "EQ",
"type": "WHERE"
},
{
"QueryColumn": {
"name": "recordType",
"alias": "RT",
"dataType": "STRING",
"length": 2,
"displayDecimals": 0,
"table": "F0005",
"tablePrefix": "DR",
"instance": "0",
"hidden": false,
"udcProductCode": "",
"udcRecordType": ""
},
"Literal": [
""
],
"operator": "EQ",
"type": "AND"
}
],
"name": "GetUDCList",
"jdeName": "F0005",
"type": "OWTABLE",
"locked": true,
"cantaraVersion": "4.1"
} Get Report Definition - TestReport
Endpoint: http://hostname:port/cantara/service/report/TestReport
Request-Method: GET
Response-Payload
JS
{
"ReportProcessingOptions": {
"ReportParameter": [
{
"name": "mnCpuSeconds",
"jdeName": "mnCpuSeconds",
"dataType": "FLOAT",
"length": 15,
"inclusion": "OPTIONAL",
"defaultValue": "10.000"
}
]
},
"ReportInterconnects": {},
"Description": "",
"name": "TestReport",
"jdeName": "RQ35CA01",
"version": "Q3500001",
"locked": false,
"printImmediate": false,
"batchQueue": "QBATCH"
}