Jump to

• Request
• Response

Get Rate Load Summary

get

/rateLoadSummaries

Request

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/rateLoadSummaries"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadSummaries

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : rateLoadSummaries

Type: object

Show Source

• domainName: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• lastApprovalDate: lastApprovalDate
  Last approved date.
• lastUploadedDate: lastUploadedDate
  Last uploaded date.
• links: array links
  Read Only: true
• rateLoadDefinitionGid: string
  Reference to rate load definition.
• rateLoadGroupGid: string
  Reference to rate load group.
• rateLoadGroups: rateLoadGroups
• rateLoadHistories: rateLoadHistories
• rateLoadRoDs: rateLoadRoDs
• rateLoadSummarySeq: number (int32)
  No description.
• rateLoadSummaryStatuses: rateLoadSummaryStatuses
• rateLoadWarningIndicator: string
  Set to "Y" if any of the uploaded rate offering s/rate records has any warnings during the rate load process.
• statusChangedBy: string
  Captures the user who last run the approval related actions on this rate load summary
• totalApprovedRateGeos: number (int32)
  Count of total rate records approved.
• totalApprovedRateOfferings: number (int32)
  Count of total rate offerings approved.
• totalUploadedRateGeos: number (int32)
  Count of total rate records uploaded.
• totalUploadedRateOfferings: number (int32)
  Count of total rate offerings uploaded.
• updateDate: updateDate
  Read Only: true

  update date
• uploadedBy: string
  Captures the user who uploaded last for this rate load summary.

{
    "properties":{
        "rateLoadSummarySeq":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadDefinitionGid":{
            "description":"Reference to rate load definition. ",
            "type":"string"
        },
        "rateLoadGroupGid":{
            "description":"Reference to rate load group. ",
            "type":"string"
        },
        "totalUploadedRateOfferings":{
            "description":"Count of total rate offerings uploaded. ",
            "type":"number",
            "format":"int32"
        },
        "totalApprovedRateOfferings":{
            "description":"Count of total rate offerings approved. ",
            "type":"number",
            "format":"int32"
        },
        "totalUploadedRateGeos":{
            "description":"Count of total rate records uploaded. ",
            "type":"number",
            "format":"int32"
        },
        "totalApprovedRateGeos":{
            "description":"Count of total rate records approved. ",
            "type":"number",
            "format":"int32"
        },
        "lastUploadedDate":{
            "description":"Last uploaded date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastApprovalDate":{
            "description":"Last approved date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "rateLoadWarningIndicator":{
            "description":"Set to \"Y\" if any of the uploaded rate offering s/rate records has any warnings during the rate load process.",
            "type":"string"
        },
        "uploadedBy":{
            "description":"Captures the user who uploaded last for this rate load summary.",
            "type":"string"
        },
        "statusChangedBy":{
            "description":"Captures the user who last run the approval related actions on this rate load summary",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "rateLoadSummaryStatuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadSummaryStatuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadHistories":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadRoDs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadGroups"
                    }
                },
                "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

insert date

Show Source

• object dateType

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

Nested Schema : lastApprovalDate

Last approved date.

Match All

Last approved date.

Show Source

• object dateTimeType

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

Nested Schema : lastUploadedDate

Last uploaded date.

Match All

Last uploaded date.

Show Source

• object dateTimeType

{
    "description":"Last uploaded date. ",
    "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 : rateLoadGroups

Type: object

Show Source

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

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

Nested Schema : rateLoadHistories

Type: object

Show Source

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

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

Nested Schema : rateLoadRoDs

Type: object

Show Source

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

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

Nested Schema : rateLoadSummaryStatuses

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

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

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadSummaries.rateLoadGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadGroups"
    }
}

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 : rateLoadSummaries.rateLoadGroups

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• rateLoadGroupGid: string
  No description.
• rateLoadGroupXid: string
  GC3 Unique identifier for the entity. Is used for creating the GID.

{
    "properties":{
        "rateLoadGroupGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadGroupXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID. ",
            "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 rateLoadSummaries.rateLoadHistories

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories"
    }
}

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 : rateLoadSummaries.rateLoadHistories

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• rateLoadErrors: rateLoadErrors
• rateLoadHistorySeq: number (int32)
  No description.
• rateLoadHistoryStatuses: rateLoadHistoryStatuses

{
    "properties":{
        "rateLoadHistorySeq":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateLoadHistoryStatuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories.rateLoadHistoryStatuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadErrors":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories.rateLoadErrors"
                    }
                },
                "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 : rateLoadErrors

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories.rateLoadErrors"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : rateLoadHistoryStatuses

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories.rateLoadHistoryStatuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadSummaries.rateLoadHistories.rateLoadErrors

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories.rateLoadErrors"
    }
}

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 : rateLoadSummaries.rateLoadHistories.rateLoadErrors

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• rateLoadErrorSequence: number (int32)
  No description.

{
    "properties":{
        "rateLoadErrorSequence":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "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 rateLoadSummaries.rateLoadHistories.rateLoadHistoryStatuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadHistories.rateLoadHistoryStatuses"
    }
}

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 : rateLoadSummaries.rateLoadHistories.rateLoadHistoryStatuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  Reference to status value GID from status value.
• statusValueGid: string
  No description.

{
    "properties":{
        "statusValueGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "statusTypeGid":{
            "description":"Reference to status value GID from status value. ",
            "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 rateLoadSummaries.rateLoadRoDs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs"
    }
}

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 : rateLoadSummaries.rateLoadRoDs

Type: object

Show Source

• domainName: string
  No description.
• lastApprovalDate: lastApprovalDate
  Captures the date and time at which the approval action is last run on this rate offering.
• lastUploadedDate: lastUploadedDate
  Captures the date and time at which the rate offering is last uploaded.
• links: array links
  Read Only: true
• operationalRoGid: string
  Parent rate offering GID of rate mgmt ro GID.
• rateLoadRoDSeq: number (int32)
  No description.
• rateLoadRoDStatuses: rateLoadRoDStatuses
• rateLoadRoDWarnings: rateLoadRoDWarnings
• rateLoadRrDs: rateLoadRrDs
• rateLoadWarningIndicator: string
  Set to "Y" if the uploaded rate offering has any warnings during the rate load process.
• rateMgmtRoGid: string
  Reference to uploaded rate offering.
• statusChangedBy: string
  Captures the user who last run the approval action on the rate offering.
• uploadedBy: string
  Captures the user who last uploaded this rate offering.
• userEnteredRoGid: string
  Rate offering Gid entered in the spreadsheet. Reference to rate load ro d seq.

{
    "properties":{
        "rateLoadRoDSeq":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateMgmtRoGid":{
            "description":"Reference to uploaded rate offering. ",
            "type":"string"
        },
        "operationalRoGid":{
            "description":"Parent rate offering GID of rate mgmt ro GID. ",
            "type":"string"
        },
        "userEnteredRoGid":{
            "description":"Rate offering Gid entered in the spreadsheet. Reference to rate load ro d seq. ",
            "type":"string"
        },
        "rateLoadWarningIndicator":{
            "description":"Set to \"Y\" if the uploaded rate offering has any warnings during the rate load process.",
            "type":"string"
        },
        "lastUploadedDate":{
            "description":"Captures the date and time at which the rate offering is last uploaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastApprovalDate":{
            "description":"Captures the date and time at which the approval action is last run on this rate offering.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedBy":{
            "description":"Captures the user who last uploaded this rate offering.",
            "type":"string"
        },
        "statusChangedBy":{
            "description":"Captures the user who last run the approval action on the rate offering.",
            "type":"string"
        },
        "rateLoadRoDStatuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRoDStatuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadRoDWarnings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRoDWarnings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadRrDs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lastApprovalDate

Captures the date and time at which the approval action is last run on this rate offering.

Match All

Captures the date and time at which the approval action is last run on this rate offering.

Show Source

• object dateTimeType

{
    "description":"Captures the date and time at which the approval action is last run on this rate offering.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lastUploadedDate

Captures the date and time at which the rate offering is last uploaded.

Match All

Captures the date and time at which the rate offering is last uploaded.

Show Source

• object dateTimeType

{
    "description":"Captures the date and time at which the rate offering is last uploaded.",
    "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 : rateLoadRoDStatuses

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRoDStatuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : rateLoadRoDWarnings

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRoDWarnings"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : rateLoadRrDs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadSummaries.rateLoadRoDs.rateLoadRoDStatuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRoDStatuses"
    }
}

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 : rateLoadSummaries.rateLoadRoDs.rateLoadRoDStatuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  Reference to status value GID from status value.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Reference to status value GID from status value. ",
            "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 rateLoadSummaries.rateLoadRoDs.rateLoadRoDWarnings

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRoDWarnings"
    }
}

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 : rateLoadSummaries.rateLoadRoDs.rateLoadRoDWarnings

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• rateLoadWarningGid: string
  Captures the rate_load_warning_gid for the uploaded rate offering.
• reason: string
  Captures the reason for the warning.

{
    "properties":{
        "rateLoadWarningGid":{
            "description":"Captures the rate_load_warning_gid for the uploaded rate offering.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reason":{
            "description":"Captures the reason for the warning.",
            "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 rateLoadSummaries.rateLoadRoDs.rateLoadRrDs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs"
    }
}

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 : rateLoadSummaries.rateLoadRoDs.rateLoadRrDs

Type: object

Show Source

• domainName: string
  No description.
• lastApprovalDate: lastApprovalDate
  Captures the date and time at which the approval action is last run on this rate record.
• lastUploadedDate: lastUploadedDate
  Captures the date and time at which the rate record is last uploaded.
• links: array links
  Read Only: true
• operationalRrGid: string
  Parent rate geo GID of rate mgmt rr GID.
• rateLoadRrDSeq: number (int32)
  No description.
• rateLoadRrDStatuses: rateLoadRrDStatuses
• rateLoadRrDWarnings: rateLoadRrDWarnings
• rateLoadSummarySeq: number (int32)
  Reference to rate load summary seq.
• rateLoadWarningIndicator: string
  Set to "Y" if the uploaded rate record has any warnings during the rate load process.
• rateMgmtRrGid: string
  Reference to rate geo and rate geo GID from the uploaded sheet.
• rateOfferingGid: string
  Rate offering GID for the uploaded rate geo GID.
• statusChangedBy: string
  Captures the user who last run the approval action on the rate record.
• uploadedBy: string
  Captures the user who last uploaded this rate record.

{
    "properties":{
        "rateLoadRrDSeq":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "rateMgmtRrGid":{
            "description":"Reference to rate geo and rate geo GID from the uploaded sheet. ",
            "type":"string"
        },
        "operationalRrGid":{
            "description":"Parent rate geo GID of rate mgmt rr GID. ",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"Rate offering GID for the uploaded rate geo GID.  ",
            "type":"string"
        },
        "rateLoadSummarySeq":{
            "description":"Reference to rate load summary seq. ",
            "type":"number",
            "format":"int32"
        },
        "rateLoadWarningIndicator":{
            "description":"Set to \"Y\" if the uploaded rate record has any warnings during the rate load process.",
            "type":"string"
        },
        "lastUploadedDate":{
            "description":"Captures the date and time at which the rate record is last uploaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastApprovalDate":{
            "description":"Captures the date and time at which the approval action is last run on this rate record.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedBy":{
            "description":"Captures the user who last uploaded this rate record.",
            "type":"string"
        },
        "statusChangedBy":{
            "description":"Captures the user who last run the approval action on the rate record.",
            "type":"string"
        },
        "rateLoadRrDWarnings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDWarnings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "rateLoadRrDStatuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDStatuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lastApprovalDate

Captures the date and time at which the approval action is last run on this rate record.

Match All

Captures the date and time at which the approval action is last run on this rate record.

Show Source

• object dateTimeType

{
    "description":"Captures the date and time at which the approval action is last run on this rate record.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lastUploadedDate

Captures the date and time at which the rate record is last uploaded.

Match All

Captures the date and time at which the rate record is last uploaded.

Show Source

• object dateTimeType

{
    "description":"Captures the date and time at which the rate record is last uploaded.",
    "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 : rateLoadRrDStatuses

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDStatuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : rateLoadRrDWarnings

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDWarnings"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDStatuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDStatuses"
    }
}

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 : rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDStatuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  Reference to status value GID from status value.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Reference to status value GID from status value. ",
            "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 rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDWarnings

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDWarnings"
    }
}

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 : rateLoadSummaries.rateLoadRoDs.rateLoadRrDs.rateLoadRrDWarnings

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• rateLoadWarningGid: string
  Captures the rate_load_warning_gid for the uploaded rate record.
• reason: string
  Captures thereason for the rate_load_warning.

{
    "properties":{
        "rateLoadWarningGid":{
            "description":"Captures the rate_load_warning_gid for the uploaded rate record.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reason":{
            "description":"Captures thereason for the rate_load_warning.",
            "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 rateLoadSummaries.rateLoadSummaryStatuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateLoadSummaries.rateLoadSummaryStatuses"
    }
}

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 : rateLoadSummaries.rateLoadSummaryStatuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  Reference to status value GID from status value.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Reference to status value GID from status value. ",
            "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
}

Back to Top