Conventions

A consistent set of conventions are followed to provide an easy and reliable environment to learn and use the Oracle Intelligent Track and Trace REST API.

URL Structure

Access the Oracle Intelligent Track and Trace REST API resources using the following URL structure :

https://instanceName-identityName.dataCenter.oraclecloud.com/bca/api/resource-path

Where:

• instanceName - Name you chose for your Oracle Intelligent Track and Trace when it was provisioned.

• identityName - Identity name you chose when you signed up with Oracle Cloud.

• dataCenter - Data center that your service is set up to use.

• resource-path - Relative path that defines the resource. For a complete list of resources, see REST Endpoints.

The following example illustrates how to use this URL structure:

GET https://MyBcaTnt-iad.bca.ocs.oraclecloud.com/bca/api/

URN Syntax

Uniform Resource Names (URNs) represents persistent, location-independent, resource identifiers.

All URNs have the following syntax: <URN> ::= "urn" <NID> ":" <NSS>

Note that the leading "urn" sequence is case insensitive.

<NID> is the namespace identifier and <NSS> is the namespace specific string.

Content Types

The JSON content produced by Oracle Intelligent Track and Trace is pretty printed, meaning that it is produced in a human readable format with line breaks and tabs.

Naming Conventions

Also by convention, the API is version-ed as v1 or v1.1. We only include the decimal in the version number when required, and prefix with a lower-case letter "v". Every API access includes the version.

Date Formats

When an user submits a document that is processed, the date format can be configured in the corresponding Handlebars template using SimpleDateFormat of Java. In the response, date format is in epoch millis.