Create a Transmission
post
/transmissions
Request
Header Parameters
-
Prefer:
An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Root Schema : schema
Type:
Show Source
object
-
dataQueueGid: string
Used to specify inbound integration data queue that will manage this transmission. If not specified, will default to the data queue configured by the glog.integration.dataqueue.inbound.
-
dataQueuePriority: number
(int64)
Used to specify a priority for this transmission to be used by a data queue poller to select transmissions for processing in priority order.
-
links: array
links
Read Only:
true
-
processGroups:
processGroups
-
processInSequence: boolean
Specifies if all the transactions in the transmission are to be processed in sequence or in parallel. The sequence is defined by the order of the transactions in the transmission. If Process Groupings are specified, then this element specifies if the groups are to be processed in sequence or in parallel. Default value is true for sequential processing.
-
referenceTransmissionNo: number
(int64)
This value can be used when this message is a response to a prior outbound transmission. In this case, it specifies to which transmission the response belongs.
-
refnums:
refnums
-
senderTransmissionId: string
Used to specify any external reference that should be associated with this transmission.
-
stopProcessOnError: boolean
Specifies if processing of the transmission should be stopped when an error occurs in a transaction. If true, processing will stop.
-
transactions(required):
transactions
Nested Schema : processGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : transactions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : transmissions.processGroups
Type:
Show Source
object
-
links: array
links
Read Only:
true
-
parentGroup: string
This is the name of the parent Process Group when using nesting of process groups.
-
processGroup: string
This is the unique name for the Process Group.
-
processInSequence: boolean
This controls whether transactions within a specific group are processed in sequence. If true, group items are processed in sequence.
-
stopProcessOnError: boolean
Specifies if processing of the group should be stopped when an error occurs in a transaction. If true, processing will stop.
Nested Schema : transmissions.refnums
Type:
Show Source
object
-
iTransmissionRefnumQualGid(required): string
Transmission reference number qualifier gid.
-
links: array
links
Read Only:
true
-
refnumValue(required): string
Reference number value.
Nested Schema : transmissions.transactions
Type:
Show Source
object
-
body: object
body
Contains the actual resource message matching the content type and resource URL.
-
contentType(required): string
No description.
-
httpMethod(required): string
No description.
-
processGroup: string
No description.
-
processSequence: string
No description.
-
referenceTransactionId: string
Specifies an alternative Transaction Number that may be assigned by the recipient for the transaction.
-
refnums:
refnums
-
resourceUrl(required): string
No description.
-
senderTransactionId: string
Specifies the Transaction Number that the sender assigned to the transaction.
Nested Schema : body
Type:
object
Contains the actual resource message matching the content type and resource URL.
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : transmissions.transactions.refnums
Type:
Show Source
object
-
iTransactionRefnumQualGid(required): string
Transaction reference number qualifier.
-
links: array
links
Read Only:
true
-
refnumValue(required): string
Reference number value.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=status
Default Response
Default Response.
Root Schema : asyncResponse
Type:
Show Source
object
-
complete: boolean
Indicates the completion status of the message.
-
endTime:
endTime
Time at which the transaction ended.
-
links: array
links
-
progress: string
Allowed Values:
[ "processing", "failed", "succeeded" ]
Indicates the completion status of the message. -
startTime:
startTime
Time at which the transaction starts.