Jump to

• Request
• Response

Get an Appointment Rule Set

get

/appointmentRuleSets/{apptRuleSetGid}

Request

Path Parameters

• apptRuleSetGid(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

• appointmentActivityType: string
  No description.
• apptAfterCutoff: apptAfterCutoff
  No description.
• apptBeforeCutoff: apptBeforeCutoff
  No description.
• apptCutoffHours: number (double)
  No description.
• apptRuleSetGid: string
  No description.
• apptRuleSetName: string
  No description.
• apptRuleSetXid: string
  No description.
• apptSsActivityProfGid: string
  No description.
• contactProfileGid: string
  No description.
• destinationRegionGid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  No description.
• equipmentGroupProfileGid: string
  No description.
• expiryDate: expiryDate
  No description.
• flexCommodityCheckOption: string
  No description.
• flexCommodityProfileGid: string
  No description.
• flexFields: flexFields
• insertDate: insertDate
  Read Only: true

  insert date
• isHazardous: boolean
  No description.
• isTemperatureControl: boolean
  No description.
• links: array links
  Read Only: true
• maximumShipUnitsAllowed: number (int32)
  No description.
• modeProfileGid: string
  No description.
• refnums: refnums
• servprovProfileGid: string
  No description.
• sourceRegionGid: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "apptRuleSetGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "apptRuleSetXid":{
            "description":"No description.",
            "type":"string"
        },
        "apptRuleSetName":{
            "description":"No description.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expiryDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "flexCommodityProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "contactProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "flexCommodityCheckOption":{
            "description":"No description.",
            "type":"string"
        },
        "isTemperatureControl":{
            "description":"No description.",
            "type":"boolean"
        },
        "isHazardous":{
            "description":"No description.",
            "type":"boolean"
        },
        "sourceRegionGid":{
            "description":"No description.",
            "type":"string"
        },
        "destinationRegionGid":{
            "description":"No description.",
            "type":"string"
        },
        "apptSsActivityProfGid":{
            "description":"No description.",
            "type":"string"
        },
        "appointmentActivityType":{
            "description":"No description.",
            "type":"string"
        },
        "maximumShipUnitsAllowed":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "apptCutoffHours":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "apptBeforeCutoff":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "apptAfterCutoff":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "flexFields":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/appointmentRuleSets.flexFields"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/appointmentRuleSets.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : apptAfterCutoff

No description.

Match All

Show Source

• object amountType

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

Nested Schema : apptBeforeCutoff

No description.

Match All

Show Source

• object amountType

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

Nested Schema : effectiveDate

No description.

Match All

Show Source

• object dateType

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

Nested Schema : expiryDate

No description.

Match All

Show Source

• object dateType

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

Nested Schema : flexFields

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/appointmentRuleSets.flexFields"
            }
        },
        "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 : refnums

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/appointmentRuleSets.refnums"
            }
        },
        "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 : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

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

Type: array

Show Source

• Array of: object appointmentRuleSets.flexFields

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/appointmentRuleSets.flexFields"
    }
}

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 : appointmentRuleSets.flexFields

Type: object

Show Source

• domainName: string
  No description.
• flexFieldName: string
  No description.
• flexFieldValue: string
  No description.
• isCompatible: boolean
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "flexFieldName":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "flexFieldValue":{
            "description":"No description.",
            "type":"string"
        },
        "isCompatible":{
            "description":"No description.",
            "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 : 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 appointmentRuleSets.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/appointmentRuleSets.refnums"
    }
}

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 : appointmentRuleSets.refnums

Type: object

Show Source

• apptRefnumQualGid: string
  No description.
• apptRefnumValue: string
  No description.
• domainName: string
  No description.
• isCompatible: boolean
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "apptRefnumQualGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "apptRefnumValue":{
            "description":"No description.",
            "type":"string"
        },
        "isCompatible":{
            "description":"No description.",
            "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