Jump to

• Request
• Response

Create a Rate Load Definition

post

/rateLoadDefinitions

Request

There are no request parameters for this operation.

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

• 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

{
    "properties":{
        "rateLoadDefinitionGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadDefinitionXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID.",
            "type":"string"
        },
        "description":{
            "description":"Description for the current rate load definition. ",
            "type":"string"
        },
        "templateRateOfferingGid":{
            "description":"Reference to rate offering which acts as template rate offering. ",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "rateLoadDefinitionInvParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadDefinitionInvParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadTemplateRoDs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTemplateRoDs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadTabDefinitions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : rateLoadDefinitionInvParties

Type: object

Show Source

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

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

Nested Schema : rateLoadTabDefinitions

Type: object

Show Source

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

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

Nested Schema : rateLoadTemplateRoDs

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

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

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadDefinitionInvParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadDefinitionInvParties"
    }
}

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 : rateLoadDefinitions.rateLoadDefinitionInvParties

Type: object

Show Source

• comMethodGid: string
  No description.
• domainName: string
  No description.
• involvedPartyContactGid: string
  No description.
• involvedPartyQualGid: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"No description.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadTabDefinitions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions"
    }
}

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 : rateLoadDefinitions.rateLoadTabDefinitions

Type: object

Show Source

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

{
    "properties":{
        "rateLoadTabDefinitionGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadTabDefinitionXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID. ",
            "type":"string"
        },
        "tabSequence":{
            "description":"Defines the sequence in which this tab will be displayed in the rate load definition. ",
            "type":"number",
            "format":"int32"
        },
        "templateRateGeoGid":{
            "description":"Defines template rate geo for the given rate load definition. ",
            "type":"string"
        },
        "isInclude":{
            "description":"Defines whether the rate geo is included in the rate load definition. ",
            "type":"boolean"
        },
        "rateLoadTemplateRrDs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : rateLoadTemplateRrDs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs"
    }
}

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 : rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs

Type: object

Show Source

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

{
    "properties":{
        "rateLoadTemplateRrDGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadTemplateRrDXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID. ",
            "type":"string"
        },
        "rateLoadFieldGid":{
            "description":"Reference of the rate load field GID. ",
            "type":"string"
        },
        "defaultDisplayName":{
            "description":"The default display name for the column. ",
            "type":"string"
        },
        "displayName":{
            "description":"User defined name for the given column. ",
            "type":"string"
        },
        "tableName":{
            "description":"The table name that the column is being pulled from. ",
            "type":"string"
        },
        "columnName":{
            "description":"The actual column name of the current column in the table. ",
            "type":"string"
        },
        "columnType":{
            "description":"The type of the column. ",
            "type":"string"
        },
        "isUsedInSpreadsheet":{
            "description":"Defines whether the field is used in spreadsheet or not. ",
            "type":"boolean"
        },
        "isReadOnly":{
            "description":"Defines whether the field is a read only field or not. ",
            "type":"boolean"
        },
        "rateLoadDefinitionGid":{
            "description":"Reference to the rate load definition GID. ",
            "type":"string"
        },
        "hierarchy":{
            "description":"Defines the dynamic hierarchy structure of rate geo structure display in rate load definition. ",
            "type":"string"
        },
        "isMandatory":{
            "description":"Set to 'Y' for rate record fields which are mandatory for creating Rate Load Definition.",
            "type":"boolean"
        },
        "isHeader":{
            "description":"Set to 'Y' if the field is a header field while creating Rate Load Definition.",
            "type":"boolean"
        },
        "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 : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadTemplateRoDs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTemplateRoDs"
    }
}

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 : rateLoadDefinitions.rateLoadTemplateRoDs

Type: object

Show Source

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

{
    "properties":{
        "rateLoadTemplateRoDGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadTemplateRoDXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID. ",
            "type":"string"
        },
        "rateLoadFieldGid":{
            "description":"Reference to rate load field GID. ",
            "type":"string"
        },
        "defaultDisplayName":{
            "description":"The default display name for the column. ",
            "type":"string"
        },
        "displayName":{
            "description":"User defined name for the column. ",
            "type":"string"
        },
        "tableName":{
            "description":"The table name that the column is being pulled from. ",
            "type":"string"
        },
        "columnName":{
            "description":"The actual column name of the current column in the table. ",
            "type":"string"
        },
        "columnType":{
            "description":"The type of the column. ",
            "type":"string"
        },
        "isUsedInSpreadsheet":{
            "description":"Defines whether the field is used in spreadsheet or not. ",
            "type":"boolean"
        },
        "isReadOnly":{
            "description":"Defines whether the field is a read only field or not. ",
            "type":"boolean"
        },
        "hierarchy":{
            "description":"Defines the dynamic hierarchy structure of rate offering structure display in rate load definition. ",
            "type":"string"
        },
        "isMandatory":{
            "description":"Set to 'Y' for rate offering fields which are mandatory for creating Rate Load Definition.",
            "type":"boolean"
        },
        "isHeader":{
            "description":"Set to 'Y' if the field is a header field while creating Rate Load Definition.",
            "type":"boolean"
        },
        "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
}

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

• 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

{
    "properties":{
        "rateLoadDefinitionGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadDefinitionXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID.",
            "type":"string"
        },
        "description":{
            "description":"Description for the current rate load definition. ",
            "type":"string"
        },
        "templateRateOfferingGid":{
            "description":"Reference to rate offering which acts as template rate offering. ",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "rateLoadDefinitionInvParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadDefinitionInvParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadTemplateRoDs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTemplateRoDs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadTabDefinitions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : rateLoadDefinitionInvParties

Type: object

Show Source

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

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

Nested Schema : rateLoadTabDefinitions

Type: object

Show Source

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

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

Nested Schema : rateLoadTemplateRoDs

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

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

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadDefinitionInvParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadDefinitionInvParties"
    }
}

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 : rateLoadDefinitions.rateLoadDefinitionInvParties

Type: object

Show Source

• comMethodGid: string
  No description.
• domainName: string
  No description.
• involvedPartyContactGid: string
  No description.
• involvedPartyQualGid: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"No description.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadTabDefinitions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions"
    }
}

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 : rateLoadDefinitions.rateLoadTabDefinitions

Type: object

Show Source

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

{
    "properties":{
        "rateLoadTabDefinitionGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadTabDefinitionXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID. ",
            "type":"string"
        },
        "tabSequence":{
            "description":"Defines the sequence in which this tab will be displayed in the rate load definition. ",
            "type":"number",
            "format":"int32"
        },
        "templateRateGeoGid":{
            "description":"Defines template rate geo for the given rate load definition. ",
            "type":"string"
        },
        "isInclude":{
            "description":"Defines whether the rate geo is included in the rate load definition. ",
            "type":"boolean"
        },
        "rateLoadTemplateRrDs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : rateLoadTemplateRrDs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs"
    }
}

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 : rateLoadDefinitions.rateLoadTabDefinitions.rateLoadTemplateRrDs

Type: object

Show Source

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

{
    "properties":{
        "rateLoadTemplateRrDGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadTemplateRrDXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID. ",
            "type":"string"
        },
        "rateLoadFieldGid":{
            "description":"Reference of the rate load field GID. ",
            "type":"string"
        },
        "defaultDisplayName":{
            "description":"The default display name for the column. ",
            "type":"string"
        },
        "displayName":{
            "description":"User defined name for the given column. ",
            "type":"string"
        },
        "tableName":{
            "description":"The table name that the column is being pulled from. ",
            "type":"string"
        },
        "columnName":{
            "description":"The actual column name of the current column in the table. ",
            "type":"string"
        },
        "columnType":{
            "description":"The type of the column. ",
            "type":"string"
        },
        "isUsedInSpreadsheet":{
            "description":"Defines whether the field is used in spreadsheet or not. ",
            "type":"boolean"
        },
        "isReadOnly":{
            "description":"Defines whether the field is a read only field or not. ",
            "type":"boolean"
        },
        "rateLoadDefinitionGid":{
            "description":"Reference to the rate load definition GID. ",
            "type":"string"
        },
        "hierarchy":{
            "description":"Defines the dynamic hierarchy structure of rate geo structure display in rate load definition. ",
            "type":"string"
        },
        "isMandatory":{
            "description":"Set to 'Y' for rate record fields which are mandatory for creating Rate Load Definition.",
            "type":"boolean"
        },
        "isHeader":{
            "description":"Set to 'Y' if the field is a header field while creating Rate Load Definition.",
            "type":"boolean"
        },
        "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 : items

Type: array

Show Source

• Array of: object rateLoadDefinitions.rateLoadTemplateRoDs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadDefinitions.rateLoadTemplateRoDs"
    }
}

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 : rateLoadDefinitions.rateLoadTemplateRoDs

Type: object

Show Source

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

{
    "properties":{
        "rateLoadTemplateRoDGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadTemplateRoDXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID. ",
            "type":"string"
        },
        "rateLoadFieldGid":{
            "description":"Reference to rate load field GID. ",
            "type":"string"
        },
        "defaultDisplayName":{
            "description":"The default display name for the column. ",
            "type":"string"
        },
        "displayName":{
            "description":"User defined name for the column. ",
            "type":"string"
        },
        "tableName":{
            "description":"The table name that the column is being pulled from. ",
            "type":"string"
        },
        "columnName":{
            "description":"The actual column name of the current column in the table. ",
            "type":"string"
        },
        "columnType":{
            "description":"The type of the column. ",
            "type":"string"
        },
        "isUsedInSpreadsheet":{
            "description":"Defines whether the field is used in spreadsheet or not. ",
            "type":"boolean"
        },
        "isReadOnly":{
            "description":"Defines whether the field is a read only field or not. ",
            "type":"boolean"
        },
        "hierarchy":{
            "description":"Defines the dynamic hierarchy structure of rate offering structure display in rate load definition. ",
            "type":"string"
        },
        "isMandatory":{
            "description":"Set to 'Y' for rate offering fields which are mandatory for creating Rate Load Definition.",
            "type":"boolean"
        },
        "isHeader":{
            "description":"Set to 'Y' if the field is a header field while creating Rate Load Definition.",
            "type":"boolean"
        },
        "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
}

Back to Top