Skip to main content
Skip table of contents

Cantara API Guide

Introduction

The primary reference for the Cantara API supported by a specific deployment should always be obtained from the installed product.

The URL to obtain the API definition is given below.

On-premises deployments:   https://<your-access-server>/<env>/ui/docs/rest/api/api-guide.html

Cloud deployments:              https://cantara.cloud/cantara/ui/docs/rest/api/api-guide.html

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 codeUsage

200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used.

204 NO CONTENT

Indicates that the request was successful but there is no content to return.

400 BAD REQUEST

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.

401 UNAUTHORIZED

The server will not process the request as the current session has not been authenticated or the session has expired.

403 FORBIDDEN

The current user does not have permission to execute the request.

404 RESOURCE NOT FOUND

Either the URL is invalid or the requested resource within the request body cannot be found.

415 UNSUPPORTED MEDIA TYPE

The request body is not in a supported format or content-type header is not set correctly.

500 INTERNAL SERVER ERROR

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
NameDescription

Accept

application/json and application/xml supported

Path Parameters

Table 1. /service/60/security/login/{environment}

ParameterDescription

environment

The Cantara login environment name

Request Body

Resource LoginRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

tenantId

Number

Cantara Tenant Identifier

apiKey

String

Tenant API Key

Parameter

Array

Login request parameters

Parameter[].name

String

Parameter name

Parameter[].value

String

Parameter value

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

Parameter

Array

Login response parameters

Parameter[].name

String

Parameter name

Parameter[].value

String

Parameter value

JdeError

Array

JDE error messages

JdeError[].alias

Number

JDE error data dictionary alias

JdeError[].description

String

JDE error message

JdeError[].type

String

JDE error type

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body

Resource FunctionRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

Parameter

Array

Function request parameters

Parameter[].name

String

Parameter name

Parameter[].value

String

Parameter value

Response Body

Resource FunctionResponse

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

Parameter

Array

Function response parameters

Parameter[].name

String

Parameter name

Parameter[].value

String

Parameter value

JdeError

Array

JDE error messages

JdeError[].alias

Number

JDE error data dictionary alias

JdeError[].description

String

JDE error message

JdeError[].type

String

JDE error type

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body

Resource QueryRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

handle

String

Open query handle identifier

startIndex

Number

Query row start index

recordCount

Number

Number of query rows to return

singlePage

Boolean

Remove open query on first page returned

CriteriaParameter

Array

Query request filter criteria parameters

CriteriaParameter[].name

String

Criteria filter name

CriteriaParameter[].CriteriaLiteral[]

Array

Criteria filter values

Response Body

Resource QueryResponse

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

Query

Object

Query response content

Query.handle

String

Open query handle identifier

Query.size

Number

Total number of query results

Query.startIndex

Number

Index of first record in result set

Query.endIndex

Number

Index of last record in result set

Query.xmlList

Boolean

Indicates whether XMLList kernel is used for queries

Query.QueryRow

Array

Query result set

Query.QueryRow[].Parameter

Array

Query row column values

Query.QueryRow[].Parameter[].name

String

Parameter name

Query.QueryRow[].Parameter[].value

String

Parameter value

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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}

ParameterDescription

handle

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body

Resource ReportRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

batchQueue

String

Report execution batch queue override

printImmediate

Boolean

Report print immediate override

createCSV

Boolean

Report create CSV override

Parameter

Array

Report request parameters

Parameter[].name

String

Parameter name

Parameter[].value

String

Parameter value

CriteriaParameter

Array

Report request filter criteria parameters

CriteriaParameter[].name

String

Criteria filter name

CriteriaParameter[].CriteriaLiteral[]

Array

Criteria filter values

Response Body

Resource ReportResponse

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

jobId

Number

Report job number

reportName

String

Report UBE name

reportVersion

String

Report UBE version

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

request

Route request as JSON string

Request Body

Resource RouteRequest

Request Body Parameters
ParameterTypeDescription

request

String

Route request JSON RouteRequest

file

Multipart

Binary file

Response Body

Resource RouteResponse

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

RouteResult

Array

Route execution results

RouteResult[].destinationId

String

Route destination key

RouteResult[].destinationType

String

Route destination type

RouteResult[].Message

Object

Route destination result message

RouteResult[].Message.type

Number

Message type identifier

RouteResult[].Message.value

String

Message description

RouteResult[].Message.sessionId

String

JDE CallObject kernel thread

RouteResult[].Message.cantaraSid

String

Web application server session ID

RouteResult[].Message.aisToken

String

JDE AIS session ID

RouteResult[].Message.origin

String

Message origin host

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Response Body

Array[Resource MediaObjectQueue]

Response Body Parameters
PathTypeDescription

[].name

String

Media object queue name

[].path

String

Media object queue path

[].queueType

String

Media object queue type

[].active

Boolean

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
NameDescription

Accept

application/octet-stream supported

Path Parameters

Table 3. /service/60/media/file/{queue}

ParameterDescription

queue

Media object queue name

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

f

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body

Resource MediaRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

ais

Boolean

AIS media access method enabled

objectName

String

Media object name

key

String

Media object key

Response Body

Resource MediaResponse

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

Query

Object

Query response content

Query.handle

String

Open query handle identifier

Query.size

Number

Total number of query results

Query.startIndex

Number

Index of first record in result set

Query.endIndex

Number

Index of last record in result set

Query.xmlList

Boolean

Indicates whether XMLList kernel is used for queries

Query.QueryRow

Array

Query result set

Query.QueryRow[].Parameter

Array

Query row column values

Query.QueryRow[].Parameter[].name

String

Parameter name

Query.QueryRow[].Parameter[].value

String

Parameter value

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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
NameDescription

Accept

application/octet-stream supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body

Resource MediaRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

ais

Boolean

AIS media access method enabled

queueName

String

Media object queue name

fileName

String

Media object file name

itemName

String

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
NameDescription

Accept

application/octet-stream supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body

Resource MediaRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

ais

Boolean

AIS media access method enabled

fileName

String

Media object file link

itemName

String

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
NameDescription

Accept

application/octet-stream supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body

Resource MediaRequest

Request Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

cantaraVersion

String

Cantara platform version

ais

Boolean

AIS media access method enabled

objectName

String

Media object name

key

String

Media object key

sequenceNo

Number

Media object sequence number

itemName

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

request

Media request as JSON string

Request Body

Resource MediaRequest

Request Body Parameters
ParameterTypeDescription

request

String

Resource MediaRequest JSON

file

Multipart

Binary file

Response Body

Resource MediaResponse

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

ais

Boolean

AIS media access method enabled

objectName

String

Media object name

key

String

Media object key

sequenceNo

Number

Media object sequence number

type

Number

Media object type code

itemName

String

Media object item name

fileName

String

Media object file name

queueName

String

Media object queue name

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

request

Media request as JSON string

Request Body

Resource MediaRequest

Request Body Parameters
ParameterTypeDescription

request

String

Resource MediaRequest JSON

file

Multipart

Binary file

Response Body

Resource MediaResponse

Response Body Parameters
PathTypeDescription

id

String

Unique request ID

name

String

Component service name

debug

String

Debug information Base64 encoded

Message

Object

Response message information

ais

Boolean

AIS media access method enabled

objectName

String

Media object name

key

String

Media object key

sequenceNo

Number

Media object sequence number

type

Number

Media object type code

itemName

String

Media object item name

fileName

String

Media object file name

queueName

String

Media object queue name

Message.type

Number

Message type identifier

Message.value

String

Message description

Message.sessionId

String

JDE CallObject kernel thread

Message.cantaraSid

String

Web application server session ID

Message.aisToken

String

JDE AIS session ID

Message.origin

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

q

Media object queue name

debug

Enable debug information in response

Request Body Parameters
ParameterTypeDescription

file

Multipart

Binary file

Response Body

Resource Message

Response Body Parameters
PathTypeDescription

type

Number

Message type identifier

value

String

Message description

sessionId

String

JDE CallObject kernel thread

cantaraSid

String

Web application server session ID

aisToken

String

JDE AIS session ID

origin

String

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
NameDescription

Accept

application/json and application/xml supported

Request Query Parameters
ParameterDescription

debug

Enable debug information in response

Request Body Parameters
ParameterTypeDescription

file

Multipart

Binary file

Response Body

Resource Message

Response Body Parameters
PathTypeDescription

type

Number

Message type identifier

value

String

Message description

sessionId

String

JDE CallObject kernel thread

cantaraSid

String

Web application server session ID

aisToken

String

JDE AIS session ID

origin

String

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"
  } ]
}
FieldDescriptionNote

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" : [ ]
}
FieldTypeDescription

name

String

Function name

Message

Resource Message

Message response information

id

Unique transaction ID

String

Parameter

Array[Parameter]

Array of response Parameter

Param: username

Parameter

Cantara login username

Param: serviceUsername

Parameter

JD Edwards service username

Param: addressNo

Parameter

User account JD Edwards address book number

Param: addressNoAlphaName

Parameter

User account JD Edwards address alpha name

Param: jobQueue

Parameter

User account JD Edwards default job queue

Param: branch

Parameter

User account JD Edwards default branch

Param: branchAddressNo

Parameter

User account JD Edwards default branch address book number

Param: branchCompany

Parameter

User account JD Edwards default branch company number

Param: branchCostCenterType

Parameter

User account JD Edwards default branch cost center type

Param: branchDescription

Parameter

User account JD Edwards default branch description

Param: approvalRouteCode

Parameter

User account JD Edwards default approval route

Param: dateFormat

Parameter

Service account date format override

Param: dateSeparator

Parameter

Service account date separator override

Param: decimalCharacter

Parameter

Service account decimal separator override

Param: decimalCharacter

Parameter

Service account decimal separator override

Param: timeZone

Parameter

Service account timezone code override

Param: timeZoneDescription

Parameter

Service account override timezone description

Param: timeZoneDescription2

Parameter

Service account override timezone offset

Param: timeZoneSpecialHandling

Parameter

Service account override timezone special handling code

Param: timeFormat

Parameter

Service account time format override

Param: daylightRule

Parameter

Service account daylight savings rule override

Param: token

Parameter

Cantara session token

Param: tokenExpiry

Parameter

Cantara session token expiry date and time

Param: fcmRegistrationId

Parameter

Firebase cloud messaging registration ID

Param: userRoles

Parameter

Service account JD Edwards assigned security roles (Pipe separated)

Param: mediaAccessMethod

Parameter

Cantara environment media access method

Param: appVersionCode

Parameter

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"
  } ]
}
FieldTypeDescription

id

String

Transaction ID

name

String

Cantara Function Name

cantaraVersion

String

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" : [ ]
}
FieldTypeDescription

name

String

Cantara Function name

Message

Resource Message

Message response information

id

String

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
}
FieldTypeDescription

id

String

Transaction ID

name

String

Cantara Query Name

cantaraVersion

String

Cantara API version code

handle

String

Open query handle ID

startIndex

Number

First index of record set to return

recordCount

Number

Total number of records in record set to return

singlePage

Boolean

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"
      } ]
    } ]
  }
}
FieldTypeDescription

name

String

Cantara Query name

Message

Resource Message

Message response information

id

String

Unique transaction ID

Query

Resource 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" ]
  } ]
}
FieldTypeDescription

id

String

Transaction ID

name

String

Cantara Report Name

cantaraVersion

String

Cantara API version code

printImmediate

Boolean

Print immediate override

batchQueue

String

Report execution batch queue override

createCSV

Boolean

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"
}
FieldTypeDescription

name

String

Cantara Report name

Message

Resource Message

Message response information

id

String

Unique transaction ID

jobId

Number

Batch job number

reportName

String

JD Edwards UBE Name

reportVersion

String

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"
    }
  ]
}
FieldTypeDescription

id

String

Transaction ID

name

String

Cantara Route Name

cantaraVersion

String

Cantara API version code

tenantID

Number

Rinami customer identifier

apiKey

String

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"
    }
  } ]
}
FieldTypeDescription

name

String

Route name

Message

Resource Message

Message response information

id

String

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"
}
FieldTypeDescription

id

String

Transaction ID

name

String

Cantara Route Name

cantaraVersion

String

Cantara API version code

ais

Boolean

AIS media access method enabled

objectName

String

Media object name

key

String

Media object key

sequenceNo

Number

Media object sequence number

type

String

Media object type code

itemName

String

Media object item name

fileName

String

Media object file name

queueName

String

Media object queue name

fileSize

String

Media object file size

text

String

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"
      } ]
    } ]
  }
}
FieldTypeDescription

name

String

Media service name

Message

Resource Message

Message response information

id

String

Unique transaction ID

Query

Resource Query

Query header response information

Param: nameObject

Resource Parameter

Media object name

Param: key

Resource Parameter

Media object key

Param: sequenceNo

Resource Parameter

Media object sequence number

Param: objectType

Resource Parameter

Media object type code

Param: itemName

Resource Parameter

Media object item name

Param: queueName

Resource Parameter

Media object queue name

Param: fileName

Resource Parameter

Media object file name

Param: futureUse1

Resource Parameter

Media object default image indicator

Resource Parameter

A Cantara request parameter

JSON Representation

{
  "name" : "param1",
  "value" : "Parameter value"
}
FieldTypeDescription

name

String

Parameter name

value

String

Parameter value

Resource CriteriaParameter

A Cantara request filter parameter

JSON Representation

{
  "name" : "param1",
  "CriteriaLiteral" : [ "Parameter value" ]
}
FieldTypeDescription

name

String

Criteria parameter name

CriteriaLiteral

Array[String]

Criteria value

Resource Message

A Cantara response information

JSON Representation

{
  "type" : 0,
  "value" : "Transaction Successful",
  "sessionId" : "3020.1591491472.3414",
  "cantaraSid" : "314",
  "aisToken" : "",
  "origin" : "HOSTNAME"
}
FieldTypeDescription

type

Number

Message type code

value

String

Message value

sessionId

String

JD Edwards Kernel Thread

cantaraSid

String

Web application session ID

aisToken

String

JD Edwards AIS server session ID

origin

String

Cantara transaction originator host

Resource JdeError

A Cantara response information

JSON Representation

{
  "alias" : "0004",
  "description" : "Date Invalid or Missing",
  "codeType" : "1"
}
FieldTypeDescription

alias

String

Error alias

description

String

Error message description

codeType

String

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"
    }... ]
  } ]
}
FieldTypeDescription

handle

String

Open query handle ID

size

Number

Total number of records in records set

startIndex

Number

Index of first record returned in records set

endIndex

Number

Index of last record returned in records set

xmlList

Boolean

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"
  } ]
}
FieldTypeDescription

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"
  }
}
FieldTypeDescription

destinationId

String

Route destination key

destinationType

String

Route destination type

Message

Resource 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
}
FieldTypeDescription

name

String

Media object queue name

path

String

Media object queue path

queueType

String

Media object queue type

active

Boolean

Media object queue active state


Version 6.0.0-RC4-SNAPSHOT
Last updated 2020-06-25 09:00:23 +1000


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.