Create New Integration
/iot/api/v2/apps/{app-id}/integrations/
Create a new Integration instance.
- Name
- Description
- Type
- Configurations
- Authentication type & its configurations
- Storage enabled flag
- Streams
- One or more message formats
- Annotations (optional)
- Stream-specific configuration (optional)
Integration Types
- ENTERPRISE
- BICS
- JDE
- MCS
- SCS
- OIC
ENTERPRISE Integration
Description: | An enterprise integration is a generic integration that can be used to POST data to an external application/cloud service. Note that we now optionally support adding custom static HTTP headers as part of the integration configuration. ENTERPRISE Integrations can be used for bi-directional data/information flow between an IoT Application and the external applications. To establish inbound channel Integration's endpoint id and shared secret are used by an application to authenticate in the IoT Cloud Service and to get authorization to access the IoT REST APIs. Outbound connection is implemented through the Integration's message dispatching mechanism. If a message's sender belongs to an IoT Application and format field in payload refers to a format, registered on one of the DeviceModels that the Application supports, the message will be mapped to the IoT Application. If the Enterprise Integration under the Application is interested in the format of the message, wihch is indicated in the format list of its streams, the message will be dispatched to the URL of the integration. |
Requirements: | Nothing specific |
Restrictions: | Stream level configuration is not supported |
Note: | Optional HTTP headers are set as a part of config (Integration level) with the key httpHeaders. |
BICS Integration
Description: | A BICS integration is an integration that can be used to forward message data to Oracle's Business Intelligence Cloud Service. BICS Integrations can be used to turn message streams into table data transmitted to and consumed by the BI Cloud Service. |
Requirements: | Each stream must have a stream-level config element of tableName which represents the name of the table to be created/populated on the BICS side. |
Restrictions: | Each stream can have one and only one message format specified. No two streams within the same integration may specify the same message format. Once a BICS stream is synchronized to the BICS server, you should avoid changes of or to the message format. The table on the BICS server will not be updated to reflect the new message structure and future synchronizations will be blocked. |
Note: | Optional HTTP headers are not supported for BICS Integrations. |
JD Edwards Integration
Description: | A JD Edwards (JDE) integration targets a particular IoT Orchestration that is exposed by a relevant JDE instance. |
Requirements: |
|
Restrictions: | Each stream should have only one format. However multiple streams per format will be supported |
Note: |
|
Mobile Cloud Service Integration
Description: | A Mobile Cloud Service (MCS) integration targets REST endpoints available on an MCS Mobile Backend. |
Requirements: |
|
Restrictions: | Stream level configuration is not supported |
Note: | Oracle-Mobile-BACKEND-ID HTTP header should be specified as part of config within httpHeaders . |
Oracle Storage Cloud Service Integration
Description: | The OSCS integration is an integration that can be used to forward message data to Oracle Storage Cloud Service (OSCS). OSCS Integrations can be used to communication with any product based on OSCS. |
Requirements: | Each stream must have a stream-level config element contains two special fields. One of them has name containerName > and the value is the name of OSCS container. Other field is named objectName > and the value is the name of object inside container. Container's and object's names in various streams need not be unique. |
Restrictions: | Each stream can have one and only one message format specified. No two streams within the same integration may specify the same message format. Once an OSCS stream is synchronized to the OSCS server, you should avoid changes of or to the message format. The table on the BICS server will not be updated to reflect the new message structure and future synchronizations will be blocked. |
Note: | Optional HTTP headers are not supported for OSCS Integrations. |
Oracle Integration Cloud Integration
Description: | The Oracle Integration Cloud integration is an integration that can be used to forward message data to an Oracle Integration Cloud (OIC) instance. |
Requirements: | Each stream should contain a value for resourceUri , which is a relative URL value of the form INTEGRATION_NAME/VERSION_STRING/RESOURCE_URL to be added to config:url . |
Restrictions: | Each stream can have only one message format specified. However, multiple streams per format will be supported. |
Note: | Optional HTTP headers are not supported for OIC Integrations. |
Request
- application/json
-
app-id: string
Unique identifier of the application
-
object
Enterprise_Integration
An enterprise integration is a generic integration that can be used to POST data to an external application/cloud service. Note that we now optionally support adding custom static HTTP headers as part of the integration configuration. ENTERPRISE Integrations can be used for bi-directional data/information flow between an IoT Application and the external applications. To establish inbound channel Integration's endpoint id and shared secret are used by an application to authenticate in the IoT Cloud Service and to get authorization to access the IoT REST APIs. Outbound connection is implemented through the Integration's message dispatching mechanism. If a message's sender belongs to an IoT Application and format field in payload refers to a format, registered on one of the DeviceModels that the Application supports, the message will be mapped to the IoT Application. If the Enterprise Integration under the Application is interested in the format of the message, wihch is indicated in the format list of its streams, the message will be dispatched to the URL of the integration.
-
object
BICS_Integration
A BICS integration is an integration that can be used to forward message data to Oracle's Business Intelligence Cloud Service. BICS Integrations can be used to turn message streams into table data transmitted to and consumed by the BI Cloud Service.
-
object
JDE_Integration
A JD Edwards (JDE) integration targets a particular IoT Orchestration that is exposed by a relevant JDE instance.
-
object
MCS_Integration
A Mobile Cloud Service (MCS) integration targets REST endpoints available on an MCS Mobile Backend.
-
object
OSCS_Integration
The OSCS integration is an integration that can be used to forward message data to Oracle Storage Cloud Service (OSCS). OSCS Integrations can be used to communication with any product based on OSCS.
-
object
OIC_Integration
The Oracle Integration Cloud integration is an integration that can be used to forward message data to an Oracle Integration Cloud (OIC) instance.
-
object
OAC_Integration
The Oracle Analytics Cloud integration is an integration that can be used to forward message data to an Oracle Analytics Cloud (OAC) instance. OAC Integrations can be used to turn message streams into table data transmitted to and consumed by an OAC instance.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
Type of authentication for outbound connections. IoT Cloud Service supports only
BASIC
authentication. -
config:
object config
Integration-level configuration. Two types of values are supported: String and Map. For ENTERPRISE Integration there is only one mandatory entry for config: url.
httpHeaders
is a reserved config entry for specifying an HTTP headers Map (key as a header name, value as the header value) for outbound connection requests. This field is mandatory. -
description:
string
Integration description
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
- sharedSecret: string
-
storageEnabled:
boolean
The flag specifying whether the Integration messages should be persisted
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
ENTERPRISE. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
Type of authentication for outbound connections. IoT Cloud Service supports only
BASIC
authentication. -
config:
object config
Integration-level configuration. Two types of values are supported: String and Map. For BICS Integration there are two mandatory entries for config:
url
andidentityDomain
. This field is mandatory. -
description:
string
Integration description
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
BICS. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for the JDE instance.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. This filed is mandatory. -
authType(optional):
string
BASIC
. This field is mandatory. -
config:
object config
Integration-level configuration. This field is mandatory.
-
description:
string
Integration description
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
storageEnabled:
boolean
Boolean value that specifies whether the messages storage should be enabled for the Integration.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
JDE. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for the MCS instance.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
BASIC
. This field is mandatory -
config:
object config
Integration-level configuration. This field is mandatory.
-
description:
string
Integration description
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
storageEnabled:
boolean
Boolean value that specifies whether the messages storage should be enabled for the Integration.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
MCS. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forOAUTH2
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
OAUTH2
. This field is mandatory. -
config:
object config
Integration-level configuration. This field is mandatory.
-
description:
string
Integration description
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
SCS. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
Type of authentication for outbound connections. IoT Cloud Service supports
BASIC
authentication. -
config:
object config
Integration-level configuration. This field is mandatory.
-
description:
string
Integration description
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
ICS. This field is mandatory. Note: For historical reasons, the predecessor to OIC, which is ICS, will be used for type.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
BASIC
. This field is mandatory. -
config:
object config
Integration-level configuration. This field is mandatory.
-
description:
string
Integration description
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
OACS. This field is mandatory. Note: For historical reasons, the predecessor to OAC, which is OACS, will be used for type.
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
password(optional):
string
Base64 encoded password.
-
username(optional):
string
Base64 encoded username.
object
httpHeaders
is a reserved config entry for specifying an HTTP headers Map (key as a header name, value as the header value) for outbound connection requests. This field is mandatory.array
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
formats(optional):
array formats
List of Message Formats the Stream is associated with. At least one Format is required for an ENTERPRISE Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.array
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
password(optional):
string
Base64 encoded password.
-
username(optional):
string
Base64 encoded username.
object
url
and identityDomain
. This field is mandatory.array
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
tableName
is supported at this moment, which means the table name on BICS cloud server side. Note that the table name value should be within 30 characters. -
formats(optional):
array formats
The Message Format the Stream is associated with. One and only one Format is required for a BICS Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
tableName
is supported at this moment, which means the table name on BICS cloud server side. Note that the table name value should be within 30 characters.array
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded. This filed is mandatory.-
password(optional):
string
Base64 encoded password.
-
username(optional):
string
Base64 encoded username.
object
-
fields(optional):
object fields
This is a required item when JDE_STANDARD message type is specified. This Map entry specifies the input data types for the each of the orchestration fields. The entries may be specified in the payload as follows:
"fields": { "orchestration_field": "field_type" }
-
messageType(optional):
string
Orchestration's supported message format (supported types:
IOT_STANDARD
(default) orJDE_STANDARD
-
orchestration(optional):
string
The target JDE IoT Orchestration. This field is mandatory
-
url(optional):
string
The JDE instance URL. This field is mandatory
array
object
"fields": { "orchestration_field": "field_type" }
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Stream level configuration. This is only required if
messageType
is set toJDE_STANDARD
-
formats(optional):
array formats
The Message Format associated with the Stream. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
messageType
is set to JDE_STANDARD
-
mapping(optional):
object mapping
This Map stores the association between the fields of the message format or an annotation to that of an orchestration's field
array
object
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
password(optional):
string
Base64 encoded password.
-
username(optional):
string
Base64 encoded username.
object
-
httpHeaders(optional):
object httpHeaders
A key-value map. Must contain a value for Oracle-Mobile-BACKEND-ID. This field is mandatory.
-
url(optional):
string
The URL to an available REST endpoint within an MCS mobile backend. This field is mandatory.
array
object
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
formats(optional):
array formats
List of Message Formats the Stream is associated with. At least one Format is required for MCS Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.array
object
username
and password
are the only credentials supported for OAUTH2
authentication. NOTE: all the authConfig values should be base64 encoded.-
password(optional):
string
Base64 encoded password.
-
username(optional):
string
Base64 encoded username.
object
-
containerName(optional):
string
Must contain a value of container name on OSCS server side. This field is mandatory.
-
dataFormat(optional):
string
Must be one of [CSV, JSON]. This field is mandatory.
-
identityDomain(optional):
string
The identity domain value of the OSCS Integration. This field is mandatory.
-
url(optional):
string
The URL to an available OSCS server. This field is mandatory.
array
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
objectName
is supported at this moment, which means name of object on OSCS cloud server side. Note that the value of object name should be within 30 characters. -
formats(optional):
array formats
The Message Format associated with the Stream. One and only one Format is required for an OSCS Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
objectName
is supported at this moment, which means name of object on OSCS cloud server side. Note that the value of object name should be within 30 characters.-
mapping(optional):
object mapping
This Map stores the association between the fields of the message format or an annotation to that of an orchestration's field
array
object
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
password(optional):
string
Base64 encoded password.
-
username(optional):
string
Base64 encoded username.
object
-
identityDomain(optional):
string
The identity domain value of the OIC Integration. This field is mandatory.
-
url(optional):
string
The URL to an available OIC server. This field is mandatory.
array
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
resourceUri
is currently supported. -
formats(optional):
array formats
The Message Format associated with the Stream. Only one Format is required for an OIC Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
resourceUri
is currently supported.-
resourceUri(optional):
object resourceUri
A relative URL value of the form INTEGRATION_NAME/VERSION_STRING/RESOURCE_URL relative to config url
array
object
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
password(optional):
string
Base64 encoded password.
-
username(optional):
string
Base64 encoded username.
object
-
identityDomain(optional):
string
The identity domain value of the OAC Integration. This field is mandatory.
-
url(optional):
string
The URL to an available OAC server. This field is mandatory.
array
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
tableName
is supported at this moment, which means the table name on OAC cloud server side. Note that the table name value should be within 30 characters. -
formats(optional):
array formats
The Message Format the Stream is associated with. One and only one Format is required for a OAC Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
tableName
is supported at this moment, which means the table name on OAC cloud server side. Note that the table name value should be within 30 characters.array
Response
- application/json
202 Response
-
object
Enterprise_Integration_receive
An enterprise integration is a generic integration that can be used to POST data to an external application/cloud service. Note that we now optionally support adding custom static HTTP headers as part of the integration configuration. ENTERPRISE Integrations can be used for bi-directional data/information flow between an IoT Application and the external applications. To establish inbound channel Integration's endpoint id and shared secret are used by an application to authenticate in the IoT Cloud Service and to get authorization to access the IoT REST APIs. Outbound connection is implemented through the Integration's message dispatching mechanism. If a message's sender belongs to an IoT Application and format field in payload refers to a format, registered on one of the DeviceModels that the Application supports, the message will be mapped to the IoT Application. If the Enterprise Integration under the Application is interested in the format of the message, wihch is indicated in the format list of its streams, the message will be dispatched to the URL of the integration.
-
object
BICS_Integration_receive
A BICS integration is an integration that can be used to forward message data to Oracle's Business Intelligence Cloud Service. BICS Integrations can be used to turn message streams into table data transmitted to and consumed by the BI Cloud Service.
-
object
JDE_Integration_receive
A JD Edwards (JDE) integration targets a particular IoT Orchestration that is exposed by a relevant JDE instance.
-
object
MCS_Integration_receive
A Mobile Cloud Service (MCS) integration targets REST endpoints available on an MCS Mobile Backend.
-
object
OSCS_Integration_receive
The OSCS integration is an integration that can be used to forward message data to Oracle Storage Cloud Service (OSCS). OSCS Integrations can be used to communication with any product based on OSCS.
-
object
OIC_Integration_receive
The Oracle Integration Cloud integration is an integration that can be used to forward message data to an Oracle Integration Cloud (OIC) instance.
-
object
OAC_Integration_receive
The Oracle Analytics Cloud integration is an integration that can be used to forward message data to an Oracle Analytics Cloud (OAC) instance.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
Type of authentication for outbound connections. IoT Cloud Service supports only
BASIC
authentication. -
config:
object config
Integration-level configuration. Two types of values are supported: String and Map. For ENTERPRISE Integration there is only one mandatory entry for config: url.
httpHeaders
is a reserved config entry for specifying an HTTP headers Map (key as a header name, value as the header value) for outbound connection requests. This field is mandatory. -
created:
number
The time when the Integration is created as a long value corresponding to epoch time in milliseconds.
-
createdAsString:
string
The time when the Integration is created as a string.
-
description:
string
Integration description
-
id:
string
ID of the Integration
-
links:
array links
Set of API navigation links
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
- sharedSecret: string
-
state:
string
State of the Integration. Valid values are [].
-
storageEnabled:
boolean
The flag specifying whether the Integration messages should be persisted
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
ENTERPRISE. This field is mandatory.
object
-
authConfig(optional):
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
Type of authentication for outbound connections. IoT Cloud Service supports only
BASIC
authentication. -
config:
object config
Integration-level configuration. Two types of values are supported: String and Map. For BICS Integration there is only one mandatory entry for config: url. This field is mandatory.
-
created:
number
The time when the Integration is created as a long value corresponding to epoch time in milliseconds.
-
createdAsString:
string
The time when the Integration is created as a string.
-
description:
string
Integration description
-
id:
string
ID of the Integration
-
links:
array links
Set of API navigation links
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
state:
string
State of the Integration. Valid values are [].
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
BICS. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for the JDE instance.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. This filed is mandatory. -
authType(optional):
string
BASIC
. This field is mandatory. -
config:
object config
Integration-level configuration. This field is mandatory.
-
created:
number
The time when the Integration is created as a long value corresponding to epoch time in milliseconds.
-
createdAsString:
string
The time when the Integration is created as a string.
-
description:
string
Integration description
-
id:
string
ID of the Integration
-
links:
array links
Set of API navigation links
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
state:
string
State of the Integration. Valid values are [].
-
storageEnabled:
boolean
Boolean value that specifies whether the messages storage should be enabled for the Integration.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
JDE. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for the MCS instance.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
BASIC
. This field is mandatory -
config:
object config
Integration-level configuration. This field is mandatory.
-
created:
number
The time when the Integration is created as a long value corresponding to epoch time in milliseconds.
-
createdAsString:
string
The time when the Integration is created as a string.
-
description:
string
Integration description
-
id:
string
ID of the Integration
-
links:
array links
Set of API navigation links
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
state:
string
State of the Integration. Valid values are [].
-
storageEnabled:
boolean
Boolean value that specifies whether the messages storage should be enabled for the Integration.
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
MCS. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forOAUTH2
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
OAUTH2
. This field is mandatory. -
config:
object config
Integration-level configuration. This field is mandatory.
-
created:
number
The time when the Integration is created as a long value corresponding to epoch time in milliseconds.
-
createdAsString:
string
The time when the Integration is created as a string.
-
description:
string
Integration description
-
id:
string
ID of the Integration
-
links:
array links
Set of API navigation links
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
state:
string
State of the Integration. Valid values are [].
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
SCS. This field is mandatory.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
BASIC
. This field is mandatory. -
config:
object config
Integration-level configuration. This field is mandatory.
-
created:
number
The time when the Integration is created as a long value corresponding to epoch time in milliseconds.
-
createdAsString:
string
The time when the Integration is created as a string.
-
description:
string
Integration description
-
id:
string
ID of the Integration
-
links:
array links
Set of API navigation links
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
state:
string
State of the Integration. Valid values are [].
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
ICS. This field is mandatory. Note: For historical reasons, the predecessor to OIC, which is ICS, will be used for type.
object
-
authConfig:
object authConfig
Authentication information for outbound connections.
username
andpassword
are the only credentials supported forBASIC
authentication. NOTE: all the authConfig values should be base64 encoded. -
authType:
string
BASIC
. This field is mandatory. -
config:
object config
Integration-level configuration. This field is mandatory.
-
created:
number
The time when the Integration is created as a long value corresponding to epoch time in milliseconds.
-
createdAsString:
string
The time when the Integration is created as a string.
-
description:
string
Integration description
-
id:
string
ID of the Integration
-
links:
array links
Set of API navigation links
-
name:
string
Integration name. NOTE: When name is omitted or a supplied as a zero-length string the implementation generates a default name automatically.
-
state:
string
State of the Integration. Valid values are [].
-
streams:
array streams
The list of Integration Streams. This field is mandatory.
-
type:
string
OACS. This field is mandatory. Note: For historical reasons, the predecessor to OAC, which is OACS, will be used for type.
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
username(optional):
string
Base64 encoded username.
object
httpHeaders
is a reserved config entry for specifying an HTTP headers Map (key as a header name, value as the header value) for outbound connection requests. This field is mandatory.array
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
formats(optional):
array formats
List of Message Formats the Stream is associated with. At least one Format is required for an ENTERPRISE Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.array
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
username(optional):
string
Base64 encoded username.
object
array
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
tableName
is supported at this moment, which means the table name on BICS cloud server side. Note that the table name value should be within 30 characters. -
formats(optional):
array formats
The Message Format the Stream is associated with. One and only one Format is required for a BICS Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
tableName
is supported at this moment, which means the table name on BICS cloud server side. Note that the table name value should be within 30 characters.array
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded. This filed is mandatory.-
username(optional):
string
Base64 encoded username.
object
-
fields(optional):
object fields
This is a required item when JDE_STANDARD message type is specified. This Map entry specifies the input data types for the each of the orchestration fields. The entries may be specified in the payload as follows:
"fields": { "orchestration_field": "field_type" }
-
messageType(optional):
string
Orchestration's supported message format (supported types:
IOT_STANDARD
(default) orJDE_STANDARD
-
orchestration(optional):
string
The target JDE IoT Orchestration. This field is mandatory
-
url(optional):
string
The JDE instance URL. This field is mandatory
array
object
"fields": { "orchestration_field": "field_type" }
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Stream level configuration. This is only required if
messageType
is set toJDE_STANDARD
-
formats(optional):
array formats
The Message Format associated with the Stream. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
messageType
is set to JDE_STANDARD
-
mapping(optional):
object mapping
This Map stores the association between the fields of the message format or an annotation to that of an orchestration's field
array
object
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
username(optional):
string
Base64 encoded username.
object
-
httpHeaders(optional):
object httpHeaders
A key-value map. Must contain a value for Oracle-Mobile-BACKEND-ID. This field is mandatory.
-
url(optional):
string
The URL to an available REST endpoint within an MCS mobile backend. This field is mandatory.
array
object
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
formats(optional):
array formats
List of Message Formats the Stream is associated with. At least one Format is required for MCS Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.array
object
username
and password
are the only credentials supported for OAUTH2
authentication. NOTE: all the authConfig values should be base64 encoded.-
username(optional):
string
Base64 encoded username.
object
-
containerName(optional):
string
Must contain a value of container name on OSCS server side. This field is mandatory.
-
dataFormat(optional):
string
Must be one of [CSV, JSON]. This field is mandatory.
-
identityDomain(optional):
string
The identity domain value of the OSCS Integration. This field is mandatory.
-
url(optional):
string
The URL to an available OSCS server. This field is mandatory.
array
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
objectName
is supported at this moment, which means name of object on OSCS cloud server side. Note that the value of object name should be within 30 characters. -
formats(optional):
array formats
The Message Format associated with the Stream. One and only one Format is required for an OSCS Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
objectName
is supported at this moment, which means name of object on OSCS cloud server side. Note that the value of object name should be within 30 characters.-
mapping(optional):
object mapping
This Map stores the association between the fields of the message format or an annotation to that of an orchestration's field
array
object
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
username(optional):
string
Base64 encoded username.
object
-
identityDomain(optional):
string
The identity domain value of the OIC Integration. This field is mandatory.
-
url(optional):
string
The URL to an available OIC server. This field is mandatory.
array
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
resourceUri
is currently supported. -
formats(optional):
array formats
The Message Format associated with the Stream. Only one Format is required for an OIC Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
resourceUri
is currently supported.-
resourceUri(optional):
object resourceUri
A relative URL value of the form INTEGRATION_NAME/VERSION_STRING/RESOURCE_URL relative to config url
array
object
object
username
and password
are the only credentials supported for BASIC
authentication. NOTE: all the authConfig values should be base64 encoded.-
username(optional):
string
Base64 encoded username.
object
-
identityDomain(optional):
string
The identity domain value of the OAC Integration. This field is mandatory.
-
url(optional):
string
The URL to an available OAC server. This field is mandatory.
array
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
object
-
annotations(optional):
object annotations
List of Message Annotations for the Stream. Currently only
source
andapps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Onlyid
is supported at this moment, which means the message will be supplied with its (or the source's) application id. -
config(optional):
object config
Additional stream options list. Only
tableName
is supported at this moment, which means the table name on OAC cloud server side. Note that the table name value should be within 30 characters. -
formats(optional):
array formats
The Message Format the Stream is associated with. One and only one Format is required for a OAC Integration. The Formats must already exist in the Application Endpoint. This field is mandatory.
object
source
and apps
types of annotations are supported. Source annotations specify the keys of endpoint metadata of the message source to be populated in the message before dispatching it to the target. Apps annotations specify application attributes to be added into the message being dispatched. Only id
is supported at this moment, which means the message will be supplied with its (or the source's) application id.object
tableName
is supported at this moment, which means the table name on OAC cloud server side. Note that the table name value should be within 30 characters.array
400 Response
401 Response
403 Response
Examples
-
Enterprise
-
Business Intelligence Cloud Service (BICS)
-
JD Edwards Integration
-
Mobile service Cloud Service (MCS)
-
Oracle Sites Cloud Service (OSCS)
-
Oracle Analytics Cloud Service (OACS)
Note:
In the request and response,iotserver
will be replaced by name and port of your assigned Oracle IoT Cloud Service instance. The format of the Cloud Service instance is
myinstance-myidentitydomain.iot.us.oraclecloud.com
and the default port is
443
Example 1
The following example shows how to create a new Enterprise Integration instance under application 0-RYJQ
by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization:Basic aW90OndlbGNvbWUx' -d @enterprise.json "http://iotserver/iot/api/v2/apps/0-RYJQ/integrations"
enterprise.json
should be as follows:
{
"name":"Application Integration Name 1468526381878",
"description":"Desc",
"type":"ENTERPRISE",
"storageEnabled":true,
"config":{
"url":"http://abc:1234"
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
]
}
]
}
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 201 Created Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body containing the endpoint Id 0-TMJQ
for the newly created Enterprise Integration instance in JSON format.
{ "id":"0-TMJQ", "type":"ENTERPRISE", "name":"Application Integration Name 1468526381878", "description":"Desc", "authType":"NO_AUTH", "config":{ "url":"http://abc:1234" }, "storageEnabled":true, "streams":[ { "formats":[ "urn:format:test:messagedeliverybyintegration:format:1:1468526374322" ], "config":{ }, "annotations":{ } } ], "state":"ACTIVATED", "sharedSecret":"ZGRwZmJlMXV1YTJlMA==", "created":1468526382018, "createdAsString":"2016-07-14T19:59:42.018Z", "resources":[ ], "links":[ { "href":"https://iotserver:7002/iot/api/v2/apps/0-RYJQ/integrations/0-TMJQ", "rel":"self" }, { "href":"https://iotserver:7002/iot/api/v2/apps/0-RYJQ/integrations/0-TMJQ", "rel":"canonical" } ] }
Example 2
0-RYJQ
by submitting a POST request on the REST resource using cURL.
curl -X POST -H 'Accept: application/json'
-H 'Content-Type: application/json'
-H 'Authorization:Basic aW90OndlbGNvbWUx'
-d @bics.json
"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations"
bics.json
file should be as follows:
{
"name":"BICS integration",
"description":"Sample description of BICS integration",
"type":"BICS",
"authType":"BASIC",
"authConfig":{
"username":"aW90OndlbGNvbWUx",
"password":"aW90OndlbGNvbWUx"
},
"config":{
"url":"https://businessintelltrial2573-usoraclecorpotrial00702.analytics.us2.oraclecloud.com",
"identityDomain":"myIdentityDomain"
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"annotations":{
"source":[
"id",
"manufacturer"
],
"apps":[
"id"
]
},
"config":{
"tableName":"TABLE_NAME"
}
}
]
}
Example of Response Header
HTTP/1.1 201 Created Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body containing the endpoint Id 0-UYJQ
for the newly created BICS Integration instance in JSON format.
{
"id":"0-UYJQ",
"type":"BICS",
"name":"BICS integration",
"description":"Sample description of BICS integration",
"authType":"BASIC",
"authConfig":{
"username":"aW90OndlbGNvbWUx"
},
"config":{
"url":"https://businessintelltrial2573-usoraclecorpotrial00702.analytics.us2.oraclecloud.com",
"identityDomain":"myIdentityDomain"
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"config":{
"tableName":"TABLE_NAME"
},
"annotations":{
"source":[
"id",
"manufacturer"
],
"apps":[
"id"
]
}
}
],
"state":"ACTIVATED",
"created":1468876689229,
"createdAsString":"2016-07-18T21:18:09.229Z",
"resources":[
],
"links":[
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-UYJQ",
"rel":"self"
},
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-UYJQ",
"rel":"canonical"
}
]
}
Example 3
0-RYJQ
by submitting a POST request on the REST resource using cURL.
curl -X POST -H 'Accept: application/json'
-H 'Content-Type: application/json'
-H 'Authorization:Basic aW90OndlbGNvbWUx'
-d @jde.json
"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations"
jde.json
file should be as follows:
{
"name":"TestJDEIntegration",
"description":"Sample description of JD Edwards integration",
"type":"JDE",
"authType":"BASIC",
"authConfig":{
"username":"aW90OndlbGNvbWUx",
"password":"aW90OndlbGNvbWUx"
},
"config":{
"url":"http://external.cloud.service.com",
"orchestration":"TestOrchestration",
"messageType":"JDE_STANDARD",
"fields":{
"field1":"INTEGER",
"field2":"STRING"
}
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"annotations":{
"apps":[
"id"
],
"source":[
"manufacturer"
]
},
"config":{
"mapping":{
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322":"field1"
}
}
}
]
}
Example of Response Header
HTTP/1.1 201 Created
Content-Type: application/json
Example of Response Body
0-U4JQ
for the newly created JDE Integration instance in JSON format.
{
"id":"0-U4JQ",
"type":"JDE",
"name":"TestJDEIntegration",
"description":"Sample description of JD Edwards integration",
"authType":"BASIC",
"authConfig":{
"username":"aW90OndlbGNvbWUx"
},
"config":{
"orchestration":"TestOrchestration",
"messageType":"JDE_STANDARD",
"fields":{
"field1":"INTEGER",
"field2":"STRING"
},
"url":"http://external.cloud.service.com"
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"config":{
"mapping":{
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322":"field1"
}
},
"annotations":{
"source":[
"manufacturer"
],
"apps":[
"id"
]
}
}
],
"state":"ACTIVATED",
"created":1468877901898,
"createdAsString":"2016-07-18T21:38:21.898Z",
"resources":[
],
"links":[
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-U4JQ",
"rel":"self"
},
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-U4JQ",
"rel":"canonical"
}
]
}
Example 4
0-RYJQ
by submitting a POST request on the REST resource using cURL.
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization:Basic aW90OndlbGNvbWUx' -d @mcs.json
"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations"
mcs.json
file should be as follows:
{
"name":"TestIntegration",
"description":"Sample description of MCS integration",
"type":"MCS",
"authType":"BASIC",
"authConfig":{
"username":"aW90OndlbGNvbWUx",
"password":"aW90OndlbGNvbWUx"
},
"config":{
"url":"http://mobile.cloud.service.com",
"httpHeaders":{
"Oracle-Mobile-BACKEND-ID":"BACKEND_ID"
}
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"annotations":{
"apps":[
"id"
],
"source":[
"id",
"manufacturer"
]
}
}
]
}
Example of Response Header
HTTP/1.1 201 Created
Content-Type: application/json
Example of Response Body
0-U4JQ
for the newly created MCS Integration instance in JSON format.
{
"id":"0-VAJQ",
"type":"MCS",
"name":"TestIntegration",
"description":"Sample description of MCS integration",
"authType":"BASIC",
"authConfig":{
"username":"aW90OndlbGNvbWUx"
},
"config":{
"url":"http://mobile.cloud.service.com",
"httpHeaders":{
"Oracle-Mobile-BACKEND-ID":"BACKEND_ID"
}
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"config":{
},
"annotations":{
"source":[
"id",
"manufacturer"
],
"apps":[
"id"
]
}
}
],
"state":"ACTIVATED",
"created":1468879029377,
"createdAsString":"2016-07-18T21:57:09.377Z",
"resources":[
],
"links":[
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-VAJQ",
"rel":"self"
},
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-VAJQ",
"rel":"canonical"
}
]
}
Example 5
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization:Basic aW90OndlbGNvbWUx' -d @oscs.json
"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations"
oscs.json
file should be as follows:
{
"name":"SCS integration",
"description":"Sample description of SCS integration",
"type":"SCS",
"authType":"OAUTH2",
"authConfig":{
"username":"aW90OndlbGNvbWUx",
"password":"aW90OndlbGNvbWUx"
},
"config":{
"identityDomain":"myIdentityDomain",
"url":"http://url.com",
"containerName":"myContainerName",
"dataFormat":"JSON"
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"annotations":{
"source":[
"metadataFromSource",
"someOtherMetadataFromSource"
],
"apps":[
"id"
]
},
"config":{
"objectName":"NAME_OF_OBJECT"
}
}
]
}
Example of Response Header
HTTP/1.1 201 Created
Content-Type: application/json
Example of Response Body
0-VIJQ
for the newly created OSCS Integration instance in JSON format.
{
"id":"0-VIJQ",
"type":"SCS",
"name":"SCS integration",
"description":"Sample description of SCS integration",
"authType":"OAUTH2",
"authConfig":{
"username":"aW90OndlbGNvbWUx"
},
"config":{
"url":"http://url.com",
"containerName":"myContainerName",
"dataFormat":"JSON",
"identityDomain":"myIdentityDomain"
},
"streams":[
{
"formats":[
"urn:format:test:messagedeliverybyintegration:format:1:1468526374322"
],
"config":{
"objectName":"NAME_OF_OBJECT"
},
"annotations":{
"source":[
"metadataFromSource",
"someOtherMetadataFromSource"
],
"apps":[
"id"
]
}
}
],
"state":"ACTIVATED",
"created":1468879399447,
"createdAsString":"2016-07-18T22:03:19.447Z",
"resources":[
],
"links":[
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-VIJQ",
"rel":"self"
},
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-VIJQ",
"rel":"canonical"
}
]
}
Example 6
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization:Basic aW90OndlbGNvbWUx' -d @oac.json
"http://iotserver/iot/api/v2/apps/0-AC/integrations"
oscs.json
file should be as follows:
{
"id": "C09C74FA-3015-4D02-B608-08E5D729E618",
"type": "OACS",
"name": "My OACS Integration",
"description": "",
"authType": "BASIC",
"authConfig": {
"username": "aW90OndlbGNvbWUx"
},
"config": {
"connectionName": "myOacConnection",
"url": "https://my.oac.oraclecloud.com",
"identityDomain": "oacIdentityDomain"
},
"storageEnabled": true,
"streams": [{
"formats": ["urn:com:oracle:iot:device:humidity_sensor:too_humid"],
"config": {
"tableName": "TableName1"
},
"annotations": {
"apps": [],
"source": []
},
"formatStatus": "relevant"
}],
"state": "ACTIVATED",
"created": 1550261730145,
"createdAsString": "2019-02-15T20:15:30.145Z",
"links": [{
"href": "https://iotserver/iot/api/v2/apps/0-AC/integrations/C09C74FA-3015-4D02-B608-08E5D729E618",
"rel": "self"
}, {
"href": "https://iotserver/iot/api/v2/apps/0-AC/integrations/C09C74FA-3015-4D02-B608-08E5D729E618",
"rel": "canonical"
}, {
"href": "https://iotserver/iot/api/v2/apps/0-AC/integrations/connectivityChecks",
"rel": "connectivityChecks"
}, {
"href": "https://iotserver/iot/api/v2/apps/0-AC/integrations/count",
"rel": "count"
}]
}
Example of Response Header
HTTP/1.1 201 Created
Content-Type: application/json
Example of Response Body
0-AC
for the newly created OACS Integration instance in JSON format.
{
"id":"C09C74FA-3015-4D02-B608-08E5D729E618",
"type":"OACS",
"name":"My OACS Integration",
"description":"",
"authType":"BASIC",
"authConfig":{
"username":"aW90OndlbGNvbWUx"
},
"config":{
"connectionName":"myOacConnection",
"url":"https://my.oac.oraclecloud.com",
"identityDomain":"oacIdentityDomain"
},
"storageEnabled":true,
"streams":[
{
"formats":[
"urn:com:oracle:iot:device:humidity_sensor:too_humid"
],
"config":{
"tableName":"TableName1"
},
"annotations":{
"apps":[
],
"source":[
]
},
"formatStatus":"relevant"
}
],
"state":"ACTIVATED",
"created":1550261730145,
"createdAsString":"2019-02-15T20:15:30.145Z",
"links":[
{
"href":"https://iotserver/iot/api/v2/apps/0-AC/integrations/C09C74FA-3015-4D02-B608-08E5D729E618",
"rel":"self"
},
{
"href":"https://iotserver/iot/api/v2/apps/0-AC/integrations/C09C74FA-3015-4D02-B608-08E5D729E618",
"rel":"canonical"
},
{
"href":"https://iotserver/iot/api/v2/apps/0-AC/integrations/connectivityChecks",
"rel":"connectivityChecks"
},
{
"href":"https://iotserver/iot/api/v2/apps/0-AC/integrations/count",
"rel":"count"
}
]
}