Jump to

• Request
• Response

Create a Transmission

post

/transmissions

Request

Header Parameters

• Prefer: string
  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

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "senderTransmissionId":{
            "description":"Used to specify any external reference that should be associated with this transmission.",
            "type":"string"
        },
        "referenceTransmissionNo":{
            "description":"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.",
            "type":"number",
            "format":"int64"
        },
        "processInSequence":{
            "description":"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.",
            "type":"boolean"
        },
        "stopProcessOnError":{
            "description":"Specifies if processing of the transmission should be stopped when an error occurs in a transaction. If true, processing will stop.",
            "type":"boolean"
        },
        "dataQueueGid":{
            "description":"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.",
            "type":"string"
        },
        "dataQueuePriority":{
            "description":"Used to specify a priority for this transmission to be used by a data queue poller to select transmissions for processing in priority order.",
            "type":"number",
            "format":"int64"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/transmissions.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "processGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/transmissions.processGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "transactions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/transmissions.transactions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    },
    "required":[
        "transactions"
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : processGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/transmissions.processGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/transmissions.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : transactions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/transmissions.transactions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object transmissions.processGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/transmissions.processGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : transmissions.processGroups

Type: object

Show Source

• 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.

{
    "properties":{
        "processGroup":{
            "description":"This is the unique name for the Process Group.",
            "type":"string"
        },
        "parentGroup":{
            "description":"This is the name of the parent Process Group when using nesting of process groups.",
            "type":"string"
        },
        "processInSequence":{
            "description":"This controls whether transactions within a specific group are processed in sequence. If true, group items are processed in sequence.",
            "type":"boolean"
        },
        "stopProcessOnError":{
            "description":"Specifies if processing of the group should be stopped when an error occurs in a transaction. If true, processing will stop.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    },
    "required":[
        "pgroupId",
        "inSequence"
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object transmissions.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/transmissions.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : transmissions.refnums

Type: object

Show Source

• iTransmissionRefnumQualGid(required): string
  Transmission reference number qualifier gid.
• links: array links
  Read Only: true
• refnumValue(required): string
  Reference number value.

{
    "properties":{
        "iTransmissionRefnumQualGid":{
            "description":"Transmission reference number qualifier gid.",
            "type":"string"
        },
        "refnumValue":{
            "description":"Reference number value.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    },
    "required":[
        "iTransmissionRefnumQualGid",
        "refnumValue"
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object transmissions.transactions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/transmissions.transactions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : transmissions.transactions

Type: object

Show Source

• 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.

{
    "properties":{
        "contentType":{
            "description":"No description.",
            "type":"string"
        },
        "httpMethod":{
            "description":"No description.",
            "type":"string"
        },
        "resourceUrl":{
            "description":"No description.",
            "type":"string"
        },
        "processGroup":{
            "description":"No description.",
            "type":"string"
        },
        "processSequence":{
            "description":"No description.",
            "type":"string"
        },
        "senderTransactionId":{
            "description":"Specifies the Transaction Number that the sender assigned to the transaction.",
            "type":"string"
        },
        "referenceTransactionId":{
            "description":"Specifies an alternative Transaction Number that may be assigned by the recipient for the transaction.",
            "type":"string"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/transmissions.transactions.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "body":{
            "description":"Contains the actual resource message matching the content type and resource URL.",
            "type":"object"
        }
    },
    "required":[
        "contentType",
        "httpMethod",
        "resourceUrl"
    ]
}

Nested Schema : body

Type: object

Contains the actual resource message matching the content type and resource URL.

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/transmissions.transactions.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object transmissions.transactions.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/transmissions.transactions.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : transmissions.transactions.refnums

Type: object

Show Source

• iTransactionRefnumQualGid(required): string
  Transaction reference number qualifier.
• links: array links
  Read Only: true
• refnumValue(required): string
  Reference number value.

{
    "properties":{
        "iTransactionRefnumQualGid":{
            "description":"Transaction reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"Reference number value.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    },
    "required":[
        "iTransactionRefnumQualGid",
        "refnumValue"
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=status

Default Response

Default Response.

Body ()

Root Schema : asyncResponse

Type: object

Show Source

• 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.

{
    "properties":{
        "startTime":{
            "description":"Time at which the transaction starts.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "progress":{
            "description":"Indicates the completion status of the message.",
            "type":"string",
            "enum":[
                "processing",
                "failed",
                "succeeded"
            ]
        },
        "complete":{
            "description":"Indicates the completion status of the message.",
            "type":"boolean"
        },
        "endTime":{
            "description":"Time at which the transaction ended.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    }
}

Nested Schema : endTime

Time at which the transaction ended.

Match All

Time at which the transaction ended.

Show Source

• object dateType

{
    "description":"Time at which the transaction ended.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : startTime

Time at which the transaction starts.

Match All

Time at which the transaction starts.

Show Source

• object dateType

{
    "description":"Time at which the transaction starts.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top