Jump to

• Request
• Response

Get Transactions

get

/transmissionReports/{iTransmissionNo}/transactions

Request

Path Parameters

• iTransmissionNo(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/transmissionReports.transactions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object transmissionReports.transactions

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : transmissionReports.transactions

Type: object

Show Source

• dataQueryTypeGid: string
  Data query type of OBJECT_GID, if populated.
• domainName: string
  No description.
• elementName: string
  ELEMENT_NAME contains the name of the transaction element. These can include: ActualShipment AllocationBase Billing Invoice Item Location Rate Release RemoteQuery ShipmentStatus TenderOffer TenderResponse TransOrder Voucher Xlane
• externalStatus: string
  Specifies the external status for the Transaction. The external status represents the result of processing at the external system.
• firstAttemptDate: firstAttemptDate
  No description.
• iTransactionNo: number (int64)
  This is a foreign key from the I_LOG table. The I_TRANSACTION_NO column specifies the transaction to which this log message pertains.
• lastAttemptDate: lastAttemptDate
  No description.
• links: array links
  Read Only: true
• objectGid: string
  No description.
• processGroup: string
  No description.
• processSequenceId: string
  No description.
• referenceTransactionId: string
  Specifies an alternative Transaction Number that may be assigned by the recipient for the transaction.
• senderTransactionId: string
  Specifies the Transaction Number that the sender assigned to the transaction.
• status: string
  STATUS indicates the status of the transaction. Status types include: FRESH New PROCESSED
• transactionCode: string
  TRANSACTION_CODE provides a code for the type of transaction that was transmitted. Transaction codes include: D I IU U Unknown
• transactionType: string
  Specifies the type of information stored in the Transmission record. For example, a record may be stored when an XML is staged via OAQ to support searching via Integration Saved Queries.
• writtenBy: string
  WRITTEN_BY contains the domain name that logged the transmission.

{
    "properties":{
        "iTransactionNo":{
            "description":"This is a foreign key from the I_LOG table. The I_TRANSACTION_NO column specifies the transaction to which this log message pertains.",
            "type":"number",
            "format":"int64"
        },
        "transactionCode":{
            "description":"TRANSACTION_CODE provides a code for the type of transaction that was transmitted. Transaction codes include: D I IU U Unknown",
            "type":"string"
        },
        "writtenBy":{
            "description":"WRITTEN_BY contains the domain name that logged the transmission.",
            "type":"string"
        },
        "status":{
            "description":"STATUS indicates the status of the transaction. Status types include: FRESH New PROCESSED",
            "type":"string"
        },
        "elementName":{
            "description":"ELEMENT_NAME contains the name of the transaction element. These can include: ActualShipment AllocationBase Billing Invoice Item Location Rate Release RemoteQuery ShipmentStatus TenderOffer TenderResponse TransOrder Voucher Xlane",
            "type":"string"
        },
        "processGroup":{
            "description":"No description.",
            "type":"string"
        },
        "processSequenceId":{
            "description":"No description.",
            "type":"string"
        },
        "objectGid":{
            "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"
        },
        "externalStatus":{
            "description":"Specifies the external status for the Transaction.  The external status represents the result of processing at the external system.",
            "type":"string"
        },
        "transactionType":{
            "description":"Specifies the type of information stored in the Transmission record.  For example, a record may be stored when an XML is staged via OAQ to support searching via Integration Saved Queries.",
            "type":"string"
        },
        "dataQueryTypeGid":{
            "description":"Data query type of OBJECT_GID, if populated.",
            "type":"string"
        },
        "firstAttemptDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastAttemptDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : firstAttemptDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lastAttemptDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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 : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top