Jump to

• Request
• Response

Get a Note

get

/tradeTransactions/{gtmTransactionGid}/lines/{gtmTransactionLineGid}/notes/{noteSequenceNo}

Request

Path Parameters

• gtmTransactionGid(required): string
  Resource ID
• gtmTransactionLineGid(required): string
  Resource ID
• noteSequenceNo(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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• enteredBy: string
  The action name or the manual intervention that resulted in this note
• isSystemGenerated: string
  Says if the note is generated by the system or manually added by the user.
• links: array links
  Read Only: true
• note: string
  Detailed description about the event.
• noteSequenceNo: number (int64)
  Sequence number of notes.
• summary: string
  High level description about the event.
• timestamp: timestamp
  Timestamp of the event that is noted.

{
    "properties":{
        "noteSequenceNo":{
            "description":"Sequence number of notes.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "timestamp":{
            "description":"Timestamp of the event that is noted.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "summary":{
            "description":"High level description about the event.",
            "type":"string"
        },
        "note":{
            "description":"Detailed description about the event.",
            "type":"string"
        },
        "enteredBy":{
            "description":"The action name or the manual intervention that resulted in this note",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Says if the note is generated by the system or manually added by the user.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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

Timestamp of the event that is noted.

Match All

Timestamp of the event that is noted.

Show Source

• object dateTimeType

{
    "description":"Timestamp of the event that is noted.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

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"
        }
    }
}

Back to Top