Get a Rate Load Definition
get
/rateLoadDefinitions/{rateLoadDefinitionGid}
Request
Path Parameters
-
rateLoadDefinitionGid(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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
description: string
Description for the current rate load definition.
-
domainName: string
No description.
-
insertDate:
insertDate
Read Only:
true
insert date -
links: array
links
Read Only:
true
-
rateLoadDefinitionGid: string
No description.
-
rateLoadDefinitionInvParties:
rateLoadDefinitionInvParties
-
rateLoadDefinitionXid: string
GC3 Unique identifier for the entity. Is used for creating the GID.
-
rateLoadTabDefinitions:
rateLoadTabDefinitions
-
rateLoadTemplateRoDs:
rateLoadTemplateRoDs
-
templateRateOfferingGid: string
Reference to rate offering which acts as template rate offering.
-
updateDate:
updateDate
Read Only:
true
update date
Nested Schema : rateLoadDefinitionInvParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : rateLoadTabDefinitions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : rateLoadTemplateRoDs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : rateLoadDefinitions.rateLoadDefinitionInvParties
Type:
Show Source
object
-
comMethodGid: string
No description.
-
domainName: string
No description.
-
involvedPartyContactGid: string
No description.
-
involvedPartyQualGid: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : rateLoadDefinitions.rateLoadTabDefinitions
Type:
Show Source
object
-
domainName: string
No description.
-
isInclude: boolean
Defines whether the rate geo is included in the rate load definition.
-
links: array
links
Read Only:
true
-
rateLoadTabDefinitionGid: string
No description.
-
rateLoadTabDefinitionXid: string
GC3 Unique identifier for the entity. Is used for creating the GID.
-
rateLoadTemplateRrDs:
rateLoadTemplateRrDs
-
tabSequence: number
(int32)
Defines the sequence in which this tab will be displayed in the rate load definition.
-
templateRateGeoGid: string
Defines template rate geo for the given rate load definition.
Nested Schema : rateLoadTemplateRrDs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs
Type:
Show Source
object
-
columnName: string
The actual column name of the current column in the table.
-
columnType: string
The type of the column.
-
defaultDisplayName: string
The default display name for the column.
-
displayName: string
User defined name for the given column.
-
domainName: string
No description.
-
hierarchy: string
Defines the dynamic hierarchy structure of rate geo structure display in rate load definition.
-
isHeader: boolean
Set to 'Y' if the field is a header field while creating Rate Load Definition.
-
isMandatory: boolean
Set to 'Y' for rate record fields which are mandatory for creating Rate Load Definition.
-
isReadOnly: boolean
Defines whether the field is a read only field or not.
-
isUsedInSpreadsheet: boolean
Defines whether the field is used in spreadsheet or not.
-
links: array
links
Read Only:
true
-
rateLoadDefinitionGid: string
Reference to the rate load definition GID.
-
rateLoadFieldGid: string
Reference of the rate load field GID.
-
rateLoadTemplateRrDGid: string
No description.
-
rateLoadTemplateRrDXid: string
GC3 Unique identifier for the entity. Is used for creating the GID.
-
tableName: string
The table name that the column is being pulled from.
Nested Schema : rateLoadDefinitions.rateLoadTemplateRoDs
Type:
Show Source
object
-
columnName: string
The actual column name of the current column in the table.
-
columnType: string
The type of the column.
-
defaultDisplayName: string
The default display name for the column.
-
displayName: string
User defined name for the column.
-
domainName: string
No description.
-
hierarchy: string
Defines the dynamic hierarchy structure of rate offering structure display in rate load definition.
-
isHeader: boolean
Set to 'Y' if the field is a header field while creating Rate Load Definition.
-
isMandatory: boolean
Set to 'Y' for rate offering fields which are mandatory for creating Rate Load Definition.
-
isReadOnly: boolean
Defines whether the field is a read only field or not.
-
isUsedInSpreadsheet: boolean
Defines whether the field is used in spreadsheet or not.
-
links: array
links
Read Only:
true
-
rateLoadFieldGid: string
Reference to rate load field GID.
-
rateLoadTemplateRoDGid: string
No description.
-
rateLoadTemplateRoDXid: string
GC3 Unique identifier for the entity. Is used for creating the GID.
-
tableName: string
The table name that the column is being pulled from.