Retrieve Integration Details
get
/iot/api/v2/apps/{app-id}/integrations/{integration-id}
Get details of Integration, specified by Integration id
Request
Path Parameters
-
app-id: string
Unique identifier of the application
-
integration-id: string
Id for the target integration
Query Parameters
-
expand(optional): string
List of fields to be expanded in the result. Use 'all' to expand all expandable fields in result
-
fields(optional): string
Comma separated list of fields to be shown in response. By default all response object fields will be present
Response
Supported Media Types
- application/json
200 Response
Successfully processed
Root Schema : schema
Match All
Show Source
-
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.
Nested Schema : Enterprise_Integration_receive
Type:
object
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.
Show Source
-
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.
Nested Schema : BICS_Integration_receive
Type:
object
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.
Show Source
-
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.
Nested Schema : JDE_Integration_receive
Type:
object
A JD Edwards (JDE) integration targets a particular IoT Orchestration that is exposed by a relevant JDE instance.
Show Source
-
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.
Nested Schema : MCS_Integration_receive
Type:
object
A Mobile Cloud Service (MCS) integration targets REST endpoints available on an MCS Mobile Backend.
Show Source
-
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.
Nested Schema : OSCS_Integration_receive
Type:
object
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.
Show Source
-
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.
Nested Schema : OIC_Integration_receive
Type:
object
The Oracle Integration Cloud integration is an integration that can be used to forward message data to an Oracle Integration Cloud (OIC) instance.
Show Source
-
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.
Nested Schema : OAC_Integration_receive
Type:
object
The Oracle Analytics Cloud integration is an integration that can be used to forward message data to an Oracle Analytics Cloud (OAC) instance.
Show Source
-
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.
Nested Schema : authConfig
Type:
object
Authentication information for outbound connections.
Show Source
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.
Nested Schema : config
Type:
object
Integration-level configuration. Two types of values are supported: String and Map. For ENTERPRISE Integration there is only one mandatory entry for config: url.
Show Source
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.Nested Schema : streams
Type:
array
The list of Integration Streams. This field is mandatory.
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : Enterprise_Integration_Stream
Type:
Show Source
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.
Nested Schema : annotations
Type:
object
List of Message Annotations for the Stream. Currently only
Show Source
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.Nested Schema : formats
Type:
array
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.
Show Source
Nested Schema : authConfig
Type:
object
Authentication information for outbound connections.
Show Source
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.
Nested Schema : config
Type:
object
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.
Show Source
Nested Schema : streams
Type:
array
The list of Integration Streams. This field is mandatory.
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : BICS_Integration_Stream
Type:
Show Source
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.
Nested Schema : annotations
Type:
object
List of Message Annotations for the Stream. Currently only
Show Source
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.Nested Schema : config
Type:
object
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.Nested Schema : formats
Type:
array
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.
Show Source
Nested Schema : authConfig
Type:
object
Authentication information for the JDE instance.
Show Source
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.
Nested Schema : config
Type:
object
Integration-level configuration. This field is mandatory.
Show Source
-
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
Nested Schema : streams
Type:
array
The list of Integration Streams. This field is mandatory.
Show Source
Nested Schema : fields
Type:
object
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" }
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : JDE_Integration_Stream
Type:
Show Source
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.
Nested Schema : annotations
Type:
object
List of Message Annotations for the Stream. Currently only
Show Source
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.Nested Schema : config
Type:
object
Stream level configuration. This is only required if
Show Source
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
Nested Schema : formats
Type:
array
The Message Format associated with the Stream. The Formats must already exist in the Application Endpoint. This field is mandatory.
Show Source
Nested Schema : mapping
Type:
object
This Map stores the association between the fields of the message format or an annotation to that of an orchestration's field
Nested Schema : authConfig
Type:
object
Authentication information for the MCS instance.
Show Source
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.
Nested Schema : config
Type:
object
Integration-level configuration. This field is mandatory.
Show Source
-
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.
Nested Schema : streams
Type:
array
The list of Integration Streams. This field is mandatory.
Show Source
Nested Schema : httpHeaders
Type:
object
A key-value map. Must contain a value for Oracle-Mobile-BACKEND-ID. This field is mandatory.
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : MCS_Integration_Stream
Type:
Show Source
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.
Nested Schema : annotations
Type:
object
List of Message Annotations for the Stream. Currently only
Show Source
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.Nested Schema : formats
Type:
array
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.
Show Source
Nested Schema : authConfig
Type:
object
Authentication information for outbound connections.
Show Source
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.
Nested Schema : config
Type:
object
Integration-level configuration. This field is mandatory.
Show Source
-
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.
Nested Schema : streams
Type:
array
The list of Integration Streams. This field is mandatory.
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : OSCS_Integration_Stream
Type:
Show Source
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.
Nested Schema : annotations
Type:
object
List of Message Annotations for the Stream. Currently only
Show Source
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.Nested Schema : config
Type:
object
Additional stream options list. Only
Show Source
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
Nested Schema : formats
Type:
array
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.
Show Source
Nested Schema : mapping
Type:
object
This Map stores the association between the fields of the message format or an annotation to that of an orchestration's field
Nested Schema : authConfig
Type:
object
Authentication information for outbound connections.
Show Source
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.
Nested Schema : config
Type:
object
Integration-level configuration. This field is mandatory.
Show Source
-
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.
Nested Schema : streams
Type:
array
The list of Integration Streams. This field is mandatory.
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : OIC_Integration_Stream
Type:
Show Source
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.
Nested Schema : annotations
Type:
object
List of Message Annotations for the Stream. Currently only
Show Source
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.Nested Schema : config
Type:
object
Additional stream options list. Only
Show Source
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
Nested Schema : formats
Type:
array
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.
Show Source
Nested Schema : resourceUri
Type:
object
A relative URL value of the form INTEGRATION_NAME/VERSION_STRING/RESOURCE_URL relative to config url
Nested Schema : authConfig
Type:
object
Authentication information for outbound connections.
Show Source
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.
Nested Schema : config
Type:
object
Integration-level configuration. This field is mandatory.
Show Source
-
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.
Nested Schema : streams
Type:
array
The list of Integration Streams. This field is mandatory.
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : OAC_Integration_Stream
Type:
Show Source
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.
Nested Schema : annotations
Type:
object
List of Message Annotations for the Stream. Currently only
Show Source
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.Nested Schema : config
Type:
object
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.Nested Schema : formats
Type:
array
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.
Show Source
401 Response
Unauthorized. The request requires user authentication.
404 Response
Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
Examples
The following example shows how to retrieve the Integration instance
0-TMJQ
under Application
0-RYJQ
by submitting a GET request on the REST resource using cURLsee
Use cURL.
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
.
curl -X GET -H 'Accept:application/json' -H 'Authorization: Basic aW90OndlbGNvbWUx' "http://iotserver/iot/api/v2/apps/0-RYJQ/integrations/0-TMJQ"
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body containing the endpoint Id for the retrieved 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":1468526570616,
"createdAsString":"2016-07-14T20:02:50.616Z",
"resources":[
],
"links":[
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-TMJQ/",
"rel":"self"
},
{
"href":"http://iotserver:7001/iot/api/v2/apps/0-RYJQ/integrations/0-TMJQ/",
"rel":"canonical"
}
]
}