Get an Appointment Rule Set
get
/locations/{locationGid}/resourceTypes/{resourceTypeGid}/resources/{locationResourceGid}/apptRuleSets/{apptRuleSetGid}
Request
Path Parameters
-
apptRuleSetGid(required): string
Resource ID
-
locationGid(required): string
Resource ID
-
locationResourceGid(required): string
Resource ID
-
resourceTypeGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
apptRuleSetGid: string
The GID for the appointment rule set.
-
domainName: string
Database domain where this data is stored.
-
flexFields:
flexFields
-
links: array
links
Read Only:
true
-
refnums:
refnums
Nested Schema : flexFields
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources.apptRuleSets.flexFields
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
flexFieldName: string
Flex field name
-
flexFieldValue: string
Flex field value.
-
isCompatible: boolean
If the flex field details on the shipment contain all the flex field details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible. -
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources.apptRuleSets.refnums
Type:
Show Source
object
-
apptRefnumQualGid: string
The appointment reference number qualifier. The qualifier related to shipment is used.
-
apptRefnumValue: string
The appointment reference number value.
-
domainName: string
Database domain where this data is stored.
-
isCompatible: boolean
If the reference number details on the shipment contain all the reference number details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.
For example, the following table contains reference number details on the shipment and appointment rule sets along with the status of compatible check box of individual rule sets.
Shipment Reference Number Qualifier and Value
Appointment Rule Set Reference Number Qualifier and Value
Q1 V1 Q1 V1, selected
Q2 V2 Q2 V2, selected
Q3 V3
Q4 V4
In this example, the shipment is compatible as the reference numbers on the shipment contain reference numbers (Q1 V1), (Q2 V2) that are defined in the appointment rule set with the compatible check box as selected.
To define shipment reference numbers constraints, enter or select the following fields, which are optional:
Reference Number Qualifier ID.
Reference Number. -
links: array
links
Read Only:
true