Cantara API Guide
Authentication
Most Cantara endpoints require an authenticated session. To authenticate you must call the Execute Login service. An example login request might look like:
POST /service/60/security/login/E1DEV HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 434
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "Login",
"cantaraVersion" : "6.0",
"tenantId" : 100001,
"apiKey" : "XXXX...XXXX",
"Parameter" : [ {
"name" : "username",
"value" : "DEMO_USER"
}, {
"name" : "password",
"value" : "Secret!"
}, {
"name" : "application",
"value" : "Storeroom"
}, {
"name" : "role",
"value" : "*ALL"
}, {
"name" : "fcmRegistrationId",
"value" : "f7et...I4LH"
} ]
}
You can also login via the use of an authentication token string instead of a password. This is useful for implementing "Remember Me" functionality so that users are not required to enter their password for each session. The expiry on authentication token strings is configured via the Cantara Administration Console and can be set per login environment. The use the authentication token string the login request might look like:
POST /service/60/security/login/E1DEV HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 386
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "Login",
"cantaraVersion" : "6.0",
"tenantId" : 100001,
"apiKey" : "XXXX...XXXX",
"Parameter" : [ {
"name" : "username",
"value" : "DEMO_USER"
}, {
"name" : "token",
"value" : "eyJh..._rHk"
}, {
"name" : "application",
"value" : "Storeroom"
}, {
"name" : "fcmRegistrationId",
"value" : "f7et...I4LH"
} ]
}
A successful login will return detailed information about the user and their session. An example response is:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1918
{
"name" : "Login",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "3020.1591491472.3414",
"cantaraSid" : "400",
"aisToken" : "",
"origin" : "HOSTNAME"
},
"id" : "7324d900-d34b-42e5-a315-0a5a3c208b1f",
"Parameter" : [ {
"name" : "username",
"value" : "DEMO_USER"
}, {
"name" : "serviceUsername",
"value" : "DEMO_USER"
}, {
"name" : "addressNo",
"value" : "1001"
}, {
"name" : "addressNoAlphaName",
"value" : "Demo User"
}, {
"name" : "jobQueue",
"value" : ""
}, {
"name" : "branch",
"value" : "M30"
}, {
"name" : "branchAddressNo",
"value" : "200002"
}, {
"name" : "branchCompany",
"value" : "00100"
}, {
"name" : "branchCostCenterType",
"value" : "XX"
}, {
"name" : "branchDescription",
"value" : "Demo Company"
}, {
"name" : "approvalRouteCode",
"value" : "RINAMI"
}, {
"name" : "dateFormat",
"value" : "DME"
}, {
"name" : "dateSeparator",
"value" : " "
}, {
"name" : "decimalCharacter",
"value" : " "
}, {
"name" : "timeZone",
"value" : "51"
}, {
"name" : "timeZoneDescription",
"value" : "Brisbane"
}, {
"name" : "timeZoneDescription2",
"value" : "(UTC+10:00)"
}, {
"name" : "timeZoneSpecialHandling",
"value" : ""
}, {
"name" : "timeFormat",
"value" : "12"
}, {
"name" : "daylightRule",
"value" : ""
}, {
"name" : "token",
"value" : "eyJh..._rHk"
}, {
"name" : "tokenExpiry",
"value" : "2020-12-31T12:00:00+10:00"
}, {
"name" : "fcmRegistrationId",
"value" : "f7et...I4LH"
}, {
"name" : "userRoles",
"value" : "DEVELOPER|INVACMRJDE|INVCLMRJDE|PROCMGRJDE|WMSMGRJDE"
}, {
"name" : "mediaAccessMethod",
"value" : "AIS"
}, {
"name" : "appVersionCode",
"value" : "1000"
} ],
"JdeError" : [ ]
}
To terminate a users session you would call the logout service. An example request would be:
POST /service/60/security/logout HTTP/1.1
Host: us.cantara.cloud
Status Codes
The following HTTP status codes are explicitly returned by the Cantara Integration Platform.
Status code | Usage |
---|---|
| Standard response for successful HTTP requests. The actual response will depend on the request method used. |
| Indicates that the request was successful but there is no content to return. |
| The server cannot or will not process the request due to something that is perceived to be a client error. For example a malformed body, invalid parameter values or incorrect message framing. |
| The server will not process the request as the current session has not been authenticated or the session has expired. |
| The current user does not have permission to execute the request. |
| Either the URL is invalid or the requested resource within the request body cannot be found. |
| The request body is not in a supported format or content-type header is not set correctly. |
| An error has occurred during the processing of the service that the Cantara server did not expect. |
Error Messages
In general the API services will attempt to returned detailed error messages in JSON format however the Java application server that is hosting the Cantara Integration Platformâ„¢ may interrupt and return standard HTML errors.
Cantara errors will come in two forms. The first will be combined with a Status Code to indicate a service error has occurred. An example error message might be:
{
"errorCode" : "400",
"errorMessage" : "Session data not defined"
}
The second form of error will be included in a Message payload. The message may be returned in isolation or as part of a service response object. An example error message is:
{
"type" : 3,
"value" : "JDE Function Error",
"sessionId" : "5344.1568725938.753",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "HOSTNAME"
}
Login Services
Login services enable authentication of clients to a specified Cantara Environment. Please refer to Authentication for further details on the login process.
Execute Login
POST /service/60/security/login/{environment}
Execute user authentication to the specified Cantara Environment.
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Path Parameters
Table 1. /service/60/security/login/{environment}
Parameter | Description |
---|---|
| The Cantara login environment name |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| Cantara Tenant Identifier |
|
| Tenant API Key |
|
| Login request parameters |
|
| Parameter name |
|
| Parameter value |
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| Login response parameters |
|
| Parameter name |
|
| Parameter value |
|
| JDE error messages |
|
| JDE error data dictionary alias |
|
| JDE error message |
|
| JDE error type |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/security/login/E1DEV HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 434
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "Login",
"cantaraVersion" : "6.0",
"tenantId" : 100001,
"apiKey" : "XXXX...XXXX",
"Parameter" : [ {
"name" : "username",
"value" : "DEMO_USER"
}, {
"name" : "password",
"value" : "Secret!"
}, {
"name" : "application",
"value" : "Storeroom"
}, {
"name" : "role",
"value" : "*ALL"
}, {
"name" : "fcmRegistrationId",
"value" : "f7et...I4LH"
} ]
}
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1918
{
"name" : "Login",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "3020.1591491472.3414",
"cantaraSid" : "400",
"aisToken" : "",
"origin" : "HOSTNAME"
},
"id" : "7324d900-d34b-42e5-a315-0a5a3c208b1f",
"Parameter" : [ {
"name" : "username",
"value" : "DEMO_USER"
}, {
"name" : "serviceUsername",
"value" : "DEMO_USER"
}, {
"name" : "addressNo",
"value" : "1001"
}, {
"name" : "addressNoAlphaName",
"value" : "Demo User"
}, {
"name" : "jobQueue",
"value" : ""
}, {
"name" : "branch",
"value" : "M30"
}, {
"name" : "branchAddressNo",
"value" : "200002"
}, {
"name" : "branchCompany",
"value" : "00100"
}, {
"name" : "branchCostCenterType",
"value" : "XX"
}, {
"name" : "branchDescription",
"value" : "Demo Company"
}, {
"name" : "approvalRouteCode",
"value" : "RINAMI"
}, {
"name" : "dateFormat",
"value" : "DME"
}, {
"name" : "dateSeparator",
"value" : " "
}, {
"name" : "decimalCharacter",
"value" : " "
}, {
"name" : "timeZone",
"value" : "51"
}, {
"name" : "timeZoneDescription",
"value" : "Brisbane"
}, {
"name" : "timeZoneDescription2",
"value" : "(UTC+10:00)"
}, {
"name" : "timeZoneSpecialHandling",
"value" : ""
}, {
"name" : "timeFormat",
"value" : "12"
}, {
"name" : "daylightRule",
"value" : ""
}, {
"name" : "token",
"value" : "eyJh..._rHk"
}, {
"name" : "tokenExpiry",
"value" : "2020-12-31T12:00:00+10:00"
}, {
"name" : "fcmRegistrationId",
"value" : "f7et...I4LH"
}, {
"name" : "userRoles",
"value" : "DEVELOPER|INVACMRJDE|INVCLMRJDE|PROCMGRJDE|WMSMGRJDE"
}, {
"name" : "mediaAccessMethod",
"value" : "AIS"
}, {
"name" : "appVersionCode",
"value" : "1000"
} ],
"JdeError" : [ ]
}
Execute Logout
POST /service/60/security/logout
Execute User Logout
Examples
Http Request
POST /service/60/security/logout HTTP/1.1
Host: us.cantara.cloud
Http Response
HTTP/1.1 204 No Content
Function Services
Execute Function
POST /service/60/function
Execute Cantara Function
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| Function request parameters |
|
| Parameter name |
|
| Parameter value |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| Function response parameters |
|
| Parameter name |
|
| Parameter value |
|
| JDE error messages |
|
| JDE error data dictionary alias |
|
| JDE error message |
|
| JDE error type |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/function/?debug=false HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 204
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "FormatLocation",
"cantaraVersion" : "6.0",
"Parameter" : [ {
"name" : "branch",
"value" : "M30"
}, {
"name" : "fileLocation",
"value" : "A1"
} ]
}
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 592
{
"name" : "FormatLocation",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "5344.1568725938.753",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"Parameter" : [ {
"name" : "branch",
"value" : "M30"
}, {
"name" : "displayLocation",
"value" : "A1. ."
}, {
"name" : "fileLocation",
"value" : "A1"
}, {
"name" : "validate",
"value" : ""
}, {
"name" : "mode",
"value" : ""
} ],
"JdeError" : [ ]
}
Query Services
Execute Query
POST /service/60/query
Execute Cantara Query
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| Open query handle identifier |
|
| Query row start index |
|
| Number of query rows to return |
|
| Remove open query on first page returned |
|
| Query request filter criteria parameters |
|
| Criteria filter name |
|
| Criteria filter values |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| Query response content |
|
| Open query handle identifier |
|
| Total number of query results |
|
| Index of first record in result set |
|
| Index of last record in result set |
|
| Indicates whether XMLList kernel is used for queries |
|
| Query result set |
|
| Query row column values |
|
| Parameter name |
|
| Parameter value |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/query/?debug=false HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 323
Host: us.cantara.cloud
{
"CriteriaParameter" : [ {
"name" : "productCode",
"CriteriaLiteral" : [ "00" ]
}, {
"name" : "recordType",
"CriteriaLiteral" : [ "ST" ]
} ],
"id" : "MOCK_ID",
"name" : "GetUDCList",
"cantaraVersion" : "6.0",
"handle" : "",
"startIndex" : 1,
"recordCount" : 5000,
"singlePage" : false
}
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2189
{
"name" : "GetUDCList",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "HOSTNAME"
},
"id" : "MOCK_ID",
"Query" : {
"handle" : "d2a713f3-6037-49a0-8c8e-47bd46a7cb40",
"size" : 18,
"startIndex" : 1,
"endIndex" : 3,
"xmlList" : false,
"QueryRow" : [ {
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
}, {
"name" : "key",
"value" : ""
}, {
"name" : "description1",
"value" : "Blank"
}, {
"name" : "description2",
"value" : ""
}, {
"name" : "specialHandling",
"value" : ""
}, {
"name" : "udcOwnership",
"value" : " "
}, {
"name" : "hardCoded",
"value" : "N"
} ]
}, {
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
}, {
"name" : "key",
"value" : " A"
}, {
"name" : "description1",
"value" : "Address Book Number"
}, {
"name" : "description2",
"value" : "Hard Coded Edit in F0101"
}, {
"name" : "specialHandling",
"value" : ""
}, {
"name" : "udcOwnership",
"value" : " "
}, {
"name" : "hardCoded",
"value" : "Y"
} ]
}, {
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
}, {
"name" : "key",
"value" : " C"
}, {
"name" : "description1",
"value" : "Business Unit Number"
}, {
"name" : "description2",
"value" : "Hard Coded Edit in F0006"
}, {
"name" : "specialHandling",
"value" : ""
}, {
"name" : "udcOwnership",
"value" : " "
}, {
"name" : "hardCoded",
"value" : "Y"
} ]
} ]
}
}
Delete Query
DELETE /service/60/query/{handle}
Delete Cantara Query
Request Information
Path Parameters
Table 2. /service/60/query/{handle}
Parameter | Description |
---|---|
| The open Cantara query handle ID |
Examples
Http Request
DELETE /service/60/query/MOCK_HANDLE HTTP/1.1
Host: us.cantara.cloud
Http Response
HTTP/1.1 204 No Content
Report Services
Execute Report
POST /service/60/report
Execute Cantara Report
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| Report execution batch queue override |
|
| Report print immediate override |
|
| Report create CSV override |
|
| Report request parameters |
|
| Parameter name |
|
| Parameter value |
|
| Report request filter criteria parameters |
|
| Criteria filter name |
|
| Criteria filter values |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| Report job number |
|
| Report UBE name |
|
| Report UBE version |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/report/?debug=false HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 393
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "SalesUpdate",
"cantaraVersion" : "6.0",
"printImmediate" : true,
"batchQueue" : "",
"createCSV" : false,
"Parameter" : [ {
"name" : "NextStatus_From",
"value" : "520"
}, {
"name" : "NextStatus_Thru",
"value" : "560"
} ],
"CriteriaParameter" : [ {
"name" : "DocumentOrderInvoiceE",
"CriteriaLiteral" : [ "9999" ]
} ]
}
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 344
{
"name" : "SalesUpdate",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"jobId" : 100,
"reportName" : "R42500",
"reportVersion" : "ZJDE0001"
}
Route Services
Execute Route
POST /service/60/route
Execute Cantara Route
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
| Route request as JSON string |
Request Body
Request Body Parameters
Parameter | Type | Description |
---|---|---|
request |
| Route request JSON RouteRequest |
file |
| Binary file |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| Route execution results |
|
| Route destination key |
|
| Route destination type |
|
| Route destination result message |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/route/?debug=false HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Accept: application/json
Host: us.cantara.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=debug
false
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=request
{"id":"MOCK_ID","name":"PrintInventoryLabel","cantaraVersion":"6.0","Parameter":[{"name":"Branch","value":"100001"}]}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=label.zpl
Content-Type: application/octet-stream
^XA
^PWN^FWN^LH2,2
^CF0,150,150
^FO240,20^FB590,1,,L,^FDCT503^FS
^FO20,20,^BQN,2,9^FDMA,52225678^FS
^CF0,100,80
^FO240,150^FB590,1,,L,^FD52225678^FS^CF0,120,100
^FO20,260^FB800,2,,L,^FDMELIODERM TURQUOISE BLUE FBL^FS
^CF0,40,40
^FO20,500^FB150,1,,L,^FDLOCN:^FS
^FO430,500^FB150,1,,L,^FDEFF:^FS
^FO430,550^FB150,1,,L,^FDEXP:^FS
^CF0,60,60
^FO130,500^FB300,1,,L,^FD04.O. . .^FS
^FO540,500^FB300,1,,L,^FD^FS
^FO540,550^FB300,1,,L,^FD^FS
^PQ1
^XZ
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 574
{
"name" : "PrintInventoryLabel",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "5344.1568725938.753",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"RouteResult" : [ {
"destinationId" : "1",
"destinationType" : "PRINTER",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "",
"aisToken" : "",
"origin" : "9034bbe06d12"
}
} ]
}
Media Services
Get Media Object Queues
GET /service/60/media/queues
Get media object queues
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Response Body
Array[Resource MediaObjectQueue]
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Media object queue name |
|
| Media object queue path |
|
| Media object queue type |
|
| Media object queue active state |
Examples
Http Request
GET /service/60/media/queues?debug=false HTTP/1.1
Accept: application/json
Host: us.cantara.cloud
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 366
[ {
"name" : "Financials",
"path" : "\\\\ftp.rinami.com\\Media92\\Financials",
"queueType" : "01",
"active" : true
}, {
"name" : "HTMLUpload",
"path" : "\\\\ftp.rinami.com\\Media92\\htmlupload",
"queueType" : "05",
"active" : true
}, {
"name" : "RINAMI",
"path" : "\\\\ftp.rinami.com\\Media92\\Rinami",
"queueType" : "01",
"active" : true
} ]
Get Media Object Queue File
GET /service/60/media/file/{queue}
Get media object queue file
Request Information
Request Headers
Name | Description |
---|---|
| application/octet-stream supported |
Path Parameters
Table 3. /service/60/media/file/{queue}
Parameter | Description |
---|---|
| Media object queue name |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
| Media object file name |
Response Body
Binary Data
Examples
Http Request
GET /service/60/media/file/RINAMI?debug=false&f=attachment.jpg HTTP/1.1
Accept: application/octet-stream
Host: us.cantara.cloud
Http Response
HTTP/1.1 200 OK
Last-Modified: Fri, 24 Jul 2020 00:33:00 GMT
Cache-Control: no-cache
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="attachment.jpg"
Get Media Objects
POST /service/60/media/list
Get Media Objects
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| AIS media access method enabled |
|
| Media object name |
|
| Media object key |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| Query response content |
|
| Open query handle identifier |
|
| Total number of query results |
|
| Index of first record in result set |
|
| Index of last record in result set |
|
| Indicates whether XMLList kernel is used for queries |
|
| Query result set |
|
| Query row column values |
|
| Parameter name |
|
| Parameter value |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/media/list?debug=false HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 143
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "GetMediaObjects",
"cantaraVersion" : "6.0",
"ais" : false,
"objectName" : "GT4101",
"key" : "60038"
}
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1047
{
"name" : "GetMediaObjects",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "5344.1568725938.753",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"Query" : {
"handle" : "",
"size" : 1,
"startIndex" : 1,
"endIndex" : 1,
"xmlList" : false,
"QueryRow" : [ {
"Parameter" : [ {
"name" : "nameObject",
"value" : "GT4101"
}, {
"name" : "key",
"value" : "60038"
}, {
"name" : "sequenceNo",
"value" : "2"
}, {
"name" : "objectType",
"value" : "1"
}, {
"name" : "itemName",
"value" : "product_image.png"
}, {
"name" : "queueName",
"value" : ""
}, {
"name" : "fileName",
"value" : "\\\\ftp.rinami.com\\Media92\\htmlupload\\FILE...3900.png"
}, {
"name" : "futureUse1",
"value" : "DEFAULT"
} ]
} ]
}
}
Download Media Object Queue File
POST /service/60/media/download
Download media object queue file
Request Information
Request Headers
Name | Description |
---|---|
| application/octet-stream supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| AIS media access method enabled |
|
| Media object queue name |
|
| Media object file name |
|
| Media object item name |
Response Body
Binary Data
Examples
Http Request
POST /service/60/media/download?debug=false HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
Content-Length: 198
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "GetMediaObjectFile",
"cantaraVersion" : "6.0",
"ais" : false,
"itemName" : "product_image.png",
"fileName" : "product_image.png",
"queueName" : "RINAMI"
}
Http Response
HTTP/1.1 200 OK
Cache-Control: no-cache
Last-Modified: Fri, 24 Jul 2020 00:33:00 GMT
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="product_image.png"
Download Media Object Link File
POST /service/60/media/download
Download media object link file
Request Information
Request Headers
Name | Description |
---|---|
| application/octet-stream supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| AIS media access method enabled |
|
| Media object file link |
|
| Media object item name |
Response Body
Binary Data
Examples
Http Request
POST /service/60/media/download?debug=false HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
Content-Length: 195
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "GetMediaObjectFile",
"cantaraVersion" : "6.0",
"ais" : false,
"itemName" : "product_image.png",
"fileName" : "http://docs.rinami.com/product_image.png"
}
Http Response
HTTP/1.1 200 OK
Cache-Control: no-cache
Last-Modified: Fri, 24 Jul 2020 00:33:00 GMT
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="http://docs.rinami.com/product_image.png"
Download Media Object AIS File
POST /service/60/media/download
Download media object AIS file
Request Information
Request Headers
Name | Description |
---|---|
| application/octet-stream supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body
Request Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Cantara platform version |
|
| AIS media access method enabled |
|
| Media object name |
|
| Media object key |
|
| Media object sequence number |
|
| Media object item name |
Response Body
Binary Data
Examples
Http Request
POST /service/60/media/download?debug=false HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
Content-Length: 201
Host: us.cantara.cloud
{
"id" : "MOCK_ID",
"name" : "GetMediaObjectFile",
"cantaraVersion" : "6.0",
"ais" : true,
"objectName" : "GT4101",
"key" : "60038",
"sequenceNo" : 2,
"itemName" : "product_image.png"
}
Http Response
HTTP/1.1 200 OK
Cache-Control: no-cache
Last-Modified: Fri, 24 Jul 2020 00:33:00 GMT
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="product_image.png"
Attach Queue File
POST /service/60/media/attach
Attach media object queue file
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Media request as JSON string |
Request Body
Request Body Parameters
Parameter | Type | Description |
---|---|---|
request |
| |
file |
| Binary file |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| AIS media access method enabled |
|
| Media object name |
|
| Media object key |
|
| Media object sequence number |
|
| Media object type code |
|
| Media object item name |
|
| Media object file name |
|
| Media object queue name |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/media/attach HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Accept: application/json
Host: us.cantara.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=request
{
"id" : "MOCK_ID",
"name" : "AttachMediaObject",
"cantaraVersion" : "6.0",
"ais" : false,
"objectName" : "GT4101",
"key" : "60038",
"type" : 1,
"itemName" : "ic_login.png",
"fileName" : "ic_login.png",
"queueName" : "RINAMI"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=ic_login.png
Content-Type: application/octet-stream
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 409
{
"id" : "MOCK_ID",
"name" : "AttachMediaObject",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "",
"aisToken" : "",
"origin" : "rnmdev11"
},
"ais" : false,
"objectName" : "GT4101",
"key" : "60038",
"sequenceNo" : 1,
"type" : 1,
"itemName" : "ic_login.png",
"fileName" : "file",
"queueName" : "",
"text" : ""
}
Attach AIS File
POST /service/60/media/attach
Attach media object AIS file
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Media request as JSON string |
Request Body
Request Body Parameters
Parameter | Type | Description |
---|---|---|
request |
| |
file |
| Binary file |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Unique request ID |
|
| Component service name |
|
| Debug information Base64 encoded |
|
| Response message information |
|
| AIS media access method enabled |
|
| Media object name |
|
| Media object key |
|
| Media object sequence number |
|
| Media object type code |
|
| Media object item name |
|
| Media object file name |
|
| Media object queue name |
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/media/attach HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Accept: application/json
Host: us.cantara.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=request
{
"id" : "MOCK_ID",
"name" : "AttachMediaObject",
"cantaraVersion" : "6.0",
"ais" : true,
"objectName" : "GT4101",
"key" : "60038",
"type" : 1,
"itemName" : "ic_login.png",
"fileName" : "ic_login.png"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=ic_login.png
Content-Type: application/octet-stream
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 423
{
"id" : "MOCK_ID",
"name" : "AttachMediaObject",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "",
"aisToken" : "",
"origin" : "rnmdev11"
},
"ais" : true,
"objectName" : "GT4101",
"key" : "60038",
"sequenceNo" : 1,
"type" : 1,
"itemName" : "ic_login.png",
"fileName" : "FILE-123...4567.png",
"queueName" : "",
"text" : ""
}
Upload Queue File
POST /service/60/media/upload
Upload media object queue file
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Media object queue name |
| Enable debug information in response |
Request Body Parameters
Parameter | Type | Description |
---|---|---|
file |
| Binary file |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/media/upload?q=RINAMI&debug=false HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Accept: application/json
Host: us.cantara.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=q
RINAMI
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=debug
false
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=ic_login.png
Content-Type: application/octet-stream
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 120
{
"type" : 0,
"value" : "",
"sessionId" : "382",
"cantaraSid" : "",
"aisToken" : "",
"origin" : "rnmdev11"
}
Upload Local File
POST /service/60/media/upload
Upload local file
Request Information
Request Headers
Name | Description |
---|---|
| application/json and application/xml supported |
Request Query Parameters
Parameter | Description |
---|---|
| Enable debug information in response |
Request Body Parameters
Parameter | Type | Description |
---|---|---|
file |
| Binary file |
Response Body
Response Body Parameters
Path | Type | Description |
---|---|---|
|
| Message type identifier |
|
| Message description |
|
| JDE CallObject kernel thread |
|
| Web application server session ID |
|
| JDE AIS session ID |
|
| Message origin host |
Examples
Http Request
POST /service/60/media/upload?debug=false HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Accept: application/json
Host: us.cantara.cloud
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=debug
false
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=ic_login.png
Content-Type: application/octet-stream
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
Http Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 120
{
"type" : 0,
"value" : "",
"sessionId" : "386",
"cantaraSid" : "",
"aisToken" : "",
"origin" : "rnmdev11"
}
Resources
Resource LoginRequest
A Cantara Function execution request specific for the Execute Login
JSON Representation
{
"id" : "MOCK_ID",
"name" : "Login",
"cantaraVersion" : "6.0",
"tenantId" : 100001,
"apiKey" : "XXXX...XXXX",
"Parameter" : [ {
"name" : "username",
"value" : "DEMO_USER"
}, {
"name" : "password",
"value" : ""
}, {
"name" : "token",
"value" : "eyJh..._rHk"
}, {
"name" : "application",
"value" : "Storeroom"
}, {
"name" : "role",
"value" : "*ALL"
}, {
"name" : "fcmRegistrationId",
"value" : "f7et...I4LH"
} ]
}
Field | Description | Note |
---|---|---|
id | Transaction ID | Optional |
name | Cantara Function Name | Login |
cantaraVersion | Cantara API version code | Optional |
tenantID | Rinami customer identifier | Required |
apiKey | Cantara Farm API key | Required |
Parameter | Array of function input Parameter | Required |
Parameter: username | Login username | Required |
Parameter: password | Login password | Required if token blank |
Parameter: token | Login token | Required if password blank |
Parameter: application | Cantara application name | Required |
Parameter: role | JD Edwards User Role | *ALL if blank |
Parameter: fcmRegistrationId | Firebase cloud management registration ID | Optional |
Resource LoginResponse
A Cantara Function execution response specific for the Execute Login
JSON Representation
{
"name" : "Login",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "3020.1591491472.3414",
"cantaraSid" : "400",
"aisToken" : "",
"origin" : "HOSTNAME"
},
"id" : "7324d900-d34b-42e5-a315-0a5a3c208b1f",
"Parameter" : [ {
"name" : "username",
"value" : "DEMO_USER"
}, {
"name" : "serviceUsername",
"value" : "DEMO_USER"
}, {
"name" : "addressNo",
"value" : "1001"
}, {
"name" : "addressNoAlphaName",
"value" : "Demo User"
}, {
"name" : "jobQueue",
"value" : ""
}, {
"name" : "branch",
"value" : "M30"
}, {
"name" : "branchAddressNo",
"value" : "200002"
}, {
"name" : "branchCompany",
"value" : "00100"
}, {
"name" : "branchCostCenterType",
"value" : "XX"
}, {
"name" : "branchDescription",
"value" : "Demo Company"
}, {
"name" : "approvalRouteCode",
"value" : "RINAMI"
}, {
"name" : "dateFormat",
"value" : "DME"
}, {
"name" : "dateSeparator",
"value" : " "
}, {
"name" : "decimalCharacter",
"value" : " "
}, {
"name" : "timeZone",
"value" : "51"
}, {
"name" : "timeZoneDescription",
"value" : "Brisbane"
}, {
"name" : "timeZoneDescription2",
"value" : "(UTC+10:00)"
}, {
"name" : "timeZoneSpecialHandling",
"value" : ""
}, {
"name" : "timeFormat",
"value" : "12"
}, {
"name" : "daylightRule",
"value" : ""
}, {
"name" : "token",
"value" : "eyJh..._rHk"
}, {
"name" : "tokenExpiry",
"value" : "2020-12-31T12:00:00+10:00"
}, {
"name" : "fcmRegistrationId",
"value" : "f7et...I4LH"
}, {
"name" : "userRoles",
"value" : "DEVELOPER|INVACMRJDE|INVCLMRJDE|PROCMGRJDE|WMSMGRJDE"
}, {
"name" : "mediaAccessMethod",
"value" : "AIS"
}, {
"name" : "appVersionCode",
"value" : "1000"
} ],
"JdeError" : [ ]
}
Field | Type | Description |
---|---|---|
name |
| Function name |
Message | Message response information | |
id | Unique transaction ID | String |
Parameter | Array[Parameter] | Array of response Parameter |
Param: username | Cantara login username | |
Param: serviceUsername | JD Edwards service username | |
Param: addressNo | User account JD Edwards address book number | |
Param: addressNoAlphaName | User account JD Edwards address alpha name | |
Param: jobQueue | User account JD Edwards default job queue | |
Param: branch | User account JD Edwards default branch | |
Param: branchAddressNo | User account JD Edwards default branch address book number | |
Param: branchCompany | User account JD Edwards default branch company number | |
Param: branchCostCenterType | User account JD Edwards default branch cost center type | |
Param: branchDescription | User account JD Edwards default branch description | |
Param: approvalRouteCode | User account JD Edwards default approval route | |
Param: dateFormat | Service account date format override | |
Param: dateSeparator | Service account date separator override | |
Param: decimalCharacter | Service account decimal separator override | |
Param: decimalCharacter | Service account decimal separator override | |
Param: timeZone | Service account timezone code override | |
Param: timeZoneDescription | Service account override timezone description | |
Param: timeZoneDescription2 | Service account override timezone offset | |
Param: timeZoneSpecialHandling | Service account override timezone special handling code | |
Param: timeFormat | Service account time format override | |
Param: daylightRule | Service account daylight savings rule override | |
Param: token | Cantara session token | |
Param: tokenExpiry | Cantara session token expiry date and time | |
Param: fcmRegistrationId | Firebase cloud messaging registration ID | |
Param: userRoles | Service account JD Edwards assigned security roles (Pipe separated) | |
Param: mediaAccessMethod | Cantara environment media access method | |
Param: appVersionCode | Cantara application version code | |
JdeError | Array[JdeError] | List of JD Edwards errors |
Resource FunctionRequest
A Cantara Function execution request
JSON Representation
{
"id" : "MOCK_ID",
"name" : "FormatLocation",
"cantaraVersion" : "6.0",
"Parameter" : [ {
"name" : "branch",
"value" : "M30"
}, {
"name" : "fileLocation",
"value" : "A1"
} ]
}
Field | Type | Description |
---|---|---|
id |
| Transaction ID |
name |
| Cantara Function Name |
cantaraVersion |
| Cantara API version code |
Parameter | Array[Parameter] | Array of function input Parameter |
Resource FunctionResponse
A Cantara Function execution response
JSON Representation
{
"name" : "FormatLocation",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "5344.1568725938.753",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"Parameter" : [ {
"name" : "branch",
"value" : "M30"
}, {
"name" : "displayLocation",
"value" : "A1. ."
}, {
"name" : "fileLocation",
"value" : "A1"
}, {
"name" : "validate",
"value" : ""
}, {
"name" : "mode",
"value" : ""
} ],
"JdeError" : [ ]
}
Field | Type | Description |
---|---|---|
name |
| Cantara Function name |
Message | Message response information | |
id |
| Unique transaction ID |
Parameter | Array[Parameter] | Array of response Parameter |
JdeError | Array[Resource JdeError] | List of JD Edwards errors |
Resource QueryRequest
A Cantara Query execution request
JSON Representation
{
"CriteriaParameter" : [ {
"name" : "productCode",
"CriteriaLiteral" : [ "00" ]
}, {
"name" : "recordType",
"CriteriaLiteral" : [ "ST" ]
} ],
"id" : "MOCK_ID",
"name" : "GetUDCList",
"cantaraVersion" : "6.0",
"handle" : "",
"startIndex" : 1,
"recordCount" : 5000,
"singlePage" : false
}
Field | Type | Description |
---|---|---|
id |
| Transaction ID |
name |
| Cantara Query Name |
cantaraVersion |
| Cantara API version code |
handle |
| Open query handle ID |
startIndex |
| First index of record set to return |
recordCount |
| Total number of records in record set to return |
singlePage |
| Remove open query on first page returned |
CriteriaParameter | Array[Resource CriteriaParameter] | Array of query filter Resource CriteriaParameter |
Resource QueryResponse
A Cantara Query execution response
JSON Representation
{
"name" : "GetUDCList",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "HOSTNAME"
},
"id" : "MOCK_ID",
"Query" : {
"handle" : "d2a713f3-6037-49a0-8c8e-47bd46a7cb40",
"size" : 18,
"startIndex" : 1,
"endIndex" : 3,
"xmlList" : false,
"QueryRow" : [ {
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
}, {
"name" : "key",
"value" : ""
}, {
"name" : "description1",
"value" : "Blank"
}, {
"name" : "description2",
"value" : ""
}, {
"name" : "specialHandling",
"value" : ""
}, {
"name" : "udcOwnership",
"value" : " "
}, {
"name" : "hardCoded",
"value" : "N"
} ]
}, {
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
}, {
"name" : "key",
"value" : " A"
}, {
"name" : "description1",
"value" : "Address Book Number"
}, {
"name" : "description2",
"value" : "Hard Coded Edit in F0101"
}, {
"name" : "specialHandling",
"value" : ""
}, {
"name" : "udcOwnership",
"value" : " "
}, {
"name" : "hardCoded",
"value" : "Y"
} ]
}, {
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
}, {
"name" : "key",
"value" : " C"
}, {
"name" : "description1",
"value" : "Business Unit Number"
}, {
"name" : "description2",
"value" : "Hard Coded Edit in F0006"
}, {
"name" : "specialHandling",
"value" : ""
}, {
"name" : "udcOwnership",
"value" : " "
}, {
"name" : "hardCoded",
"value" : "Y"
} ]
} ]
}
}
Field | Type | Description |
---|---|---|
name |
| Cantara Query name |
Message | Message response information | |
id |
| Unique transaction ID |
Query | Query header response information |
Resource ReportRequest
A Cantara Report execution request
JSON Representation
{
"id" : "MOCK_ID",
"name" : "SalesUpdate",
"cantaraVersion" : "6.0",
"printImmediate" : true,
"batchQueue" : "",
"createCSV" : false,
"Parameter" : [ {
"name" : "NextStatus_From",
"value" : "520"
}, {
"name" : "NextStatus_Thru",
"value" : "560"
} ],
"CriteriaParameter" : [ {
"name" : "DocumentOrderInvoiceE",
"CriteriaLiteral" : [ "9999" ]
} ]
}
Field | Type | Description |
---|---|---|
id |
| Transaction ID |
name |
| Cantara Report Name |
cantaraVersion |
| Cantara API version code |
printImmediate |
| Print immediate override |
batchQueue |
| Report execution batch queue override |
createCSV |
| Create CSV output override |
Parameter | Array[Resource Parameter] | Array of report input Resource Parameter |
CriteriaParameter | Array[Resource CriteriaParameter] | Array of report filter Resource CriteriaParameter |
Resource ReportResponse
A Cantara Report execution response
JSON Representation
{
"name" : "SalesUpdate",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"jobId" : 100,
"reportName" : "R42500",
"reportVersion" : "ZJDE0001"
}
Field | Type | Description |
---|---|---|
name |
| Cantara Report name |
Message | Message response information | |
id |
| Unique transaction ID |
jobId |
| Batch job number |
reportName |
| JD Edwards UBE Name |
reportVersion |
| JD Edwards UBE Version |
Resource RouteRequest
A Cantara Report execution request
JSON Representation
{
"id": "MOCK_ID",
"name": "PrintInventoryLabel",
"cantaraVersion": "6.0",
"tenantId": 0,
"apiKey": "",
"Parameter": [
{
"name": "Branch",
"value": "100001"
}
]
}
Field | Type | Description |
---|---|---|
id |
| Transaction ID |
name |
| Cantara Route Name |
cantaraVersion |
| Cantara API version code |
tenantID |
| Rinami customer identifier |
apiKey |
| Cantara Farm API key |
Parameter | Array[Resource Parameter] | Array of route input Resource Parameter |
Resource RouteResponse
A Cantara Route execution response
JSON Representation
{
"name" : "PrintInventoryLabel",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "5344.1568725938.753",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"RouteResult" : [ {
"destinationId" : "1",
"destinationType" : "PRINTER",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "",
"aisToken" : "",
"origin" : "9034bbe06d12"
}
} ]
}
Field | Type | Description |
---|---|---|
name |
| Route name |
Message | Message response information | |
id |
| Unique transaction ID |
RouteResult | Array[Resource DestinationResult] | Array of results for each route destination |
Resource MediaRequest
A Cantara Report execution request
JSON Representation
{
"id" : "MOCK_ID",
"name" : "GetMediaObjects",
"cantaraVersion" : "6.0",
"ais" : false,
"objectName" : "GT4101",
"key" : "60038",
"sequenceNo": 1,
"type": "1",
"itemName": "product_image.png",
"fileName": "product_image.png",
"queueName": "RINAMI",
"fileSize": "1MB",
"text": "product_image.png"
}
Field | Type | Description |
---|---|---|
id |
| Transaction ID |
name |
| Cantara Route Name |
cantaraVersion |
| Cantara API version code |
ais |
| AIS media access method enabled |
objectName |
| Media object name |
key |
| Media object key |
sequenceNo |
| Media object sequence number |
type |
| Media object type code |
itemName |
| Media object item name |
fileName |
| Media object file name |
queueName |
| Media object queue name |
fileSize |
| Media object file size |
text |
| Media object text content |
Resource MediaResponse
A Media Object list response
JSON Representation
{
"name" : "GetMediaObjects",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "5344.1568725938.753",
"cantaraSid" : "dda6eb78-2370-463b-b8a3-979a0242fe0e",
"aisToken" : "044q...MTY5",
"origin" : "9034bbe06d12"
},
"id" : "MOCK_ID",
"Query" : {
"handle" : "",
"size" : 1,
"startIndex" : 1,
"endIndex" : 1,
"xmlList" : false,
"QueryRow" : [ {
"Parameter" : [ {
"name" : "nameObject",
"value" : "GT4101"
}, {
"name" : "key",
"value" : "60038"
}, {
"name" : "sequenceNo",
"value" : "2"
}, {
"name" : "objectType",
"value" : "1"
}, {
"name" : "itemName",
"value" : "product_image.png"
}, {
"name" : "queueName",
"value" : ""
}, {
"name" : "fileName",
"value" : "\\\\ftp.rinami.com\\Media92\\htmlupload\\FILE...3900.png"
}, {
"name" : "futureUse1",
"value" : "DEFAULT"
} ]
} ]
}
}
Field | Type | Description |
---|---|---|
name |
| Media service name |
Message | Resource Message | Message response information |
id |
| Unique transaction ID |
Query | Query header response information | |
Param: nameObject | Media object name | |
Param: key | Media object key | |
Param: sequenceNo | Media object sequence number | |
Param: objectType | Media object type code | |
Param: itemName | Media object item name | |
Param: queueName | Media object queue name | |
Param: fileName | Media object file name | |
Param: futureUse1 | Media object default image indicator |
Resource Parameter
A Cantara request parameter
JSON Representation
{
"name" : "param1",
"value" : "Parameter value"
}
Field | Type | Description |
---|---|---|
name |
| Parameter name |
value |
| Parameter value |
Resource CriteriaParameter
A Cantara request filter parameter
JSON Representation
{
"name" : "param1",
"CriteriaLiteral" : [ "Parameter value" ]
}
Field | Type | Description |
---|---|---|
name |
| Criteria parameter name |
CriteriaLiteral |
| Criteria value |
Resource Message
A Cantara response information
JSON Representation
{
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "3020.1591491472.3414",
"cantaraSid" : "314",
"aisToken" : "",
"origin" : "HOSTNAME"
}
Field | Type | Description |
---|---|---|
type |
| Message type code |
value |
| Message value |
sessionId |
| JD Edwards Kernel Thread |
cantaraSid |
| Web application session ID |
aisToken |
| JD Edwards AIS server session ID |
origin |
| Cantara transaction originator host |
Resource JdeError
A Cantara response information
JSON Representation
{
"alias" : "0004",
"description" : "Date Invalid or Missing",
"codeType" : "1"
}
Field | Type | Description |
---|---|---|
alias |
| Error alias |
description |
| Error message description |
codeType |
| Error message level |
Resource Query
Cantara Query response header
JSON Representation
{
"handle" : "d2a713f3-6037-49a0-8c8e-47bd46a7cb40",
"size" : 18,
"startIndex" : 1,
"endIndex" : 3,
"xmlList" : false,
"QueryRow" : [ {
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
}... ]
} ]
}
Field | Type | Description |
---|---|---|
handle |
| Open query handle ID |
size |
| Total number of records in records set |
startIndex |
| Index of first record returned in records set |
endIndex |
| Index of last record returned in records set |
xmlList |
| Indicates whether XMLList kernel is used for queries |
QueryRow | Array[Resource QueryRow] | Query record set |
Resource QueryRow
Cantara Query response header
JSON Representation
{
"Parameter" : [ {
"name" : "productCode",
"value" : "00"
}, {
"name" : "recordType",
"value" : "ST"
} ]
}
Field | Type | Description |
---|---|---|
Parameter | Array[Resource Parameter] | Array of query result columns |
Resource DestinationResult
A Cantara Route destination result
JSON Representation
{
"destinationId" : "1",
"destinationType" : "PRINTER",
"Message" : {
"type" : 0,
"value" : "Transaction Successful",
"sessionId" : "",
"cantaraSid" : "",
"aisToken" : "",
"origin" : "9034bbe06d12"
}
}
Field | Type | Description |
---|---|---|
destinationId |
| Route destination key |
destinationType |
| Route destination type |
Message | Message response information |
Resource MediaObjectQueue
JD Edwards Media Object Queue definition
JSON Representation
{
"name" : "RINAMI",
"path" : "\\\\ftp.rinami.com\\Media92\\Rinami",
"queueType" : "01",
"active" : true
}
Field | Type | Description |
---|---|---|
name |
| Media object queue name |
path |
| Media object queue path |
queueType |
| Media object queue type |
active |
| Media object queue active state |
Version 6.0.0-RC4-SNAPSHOT
Last updated 2020-06-25 09:00:23 +1000
On This Page