Jump to

• Request
• Response

Get Appointment Rule Sets

get

/locations/{locationGid}/resourceTypes/{resourceTypeGid}/resources/{locationResourceGid}/apptRuleSets

Request

Path Parameters

• 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.
• 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/locations.resourceTypes.resources.apptRuleSets"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources.apptRuleSets

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : locations.resourceTypes.resources.apptRuleSets

Type: object

Show Source

• 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

{
    "properties":{
        "apptRuleSetGid":{
            "description":"The GID for the appointment rule set.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexFields":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.flexFields"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : flexFields

Type: object

Show Source

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

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

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources.apptRuleSets.flexFields

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.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 : locations.resourceTypes.resources.apptRuleSets.flexFields

Type: object

Show Source

• 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

{
    "properties":{
        "flexFieldName":{
            "description":"Flex field name",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexFieldValue":{
            "description":"Flex field value.",
            "type":"string"
        },
        "isCompatible":{
            "description":"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.<br>If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible.",
            "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 locations.resourceTypes.resources.apptRuleSets.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.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 : locations.resourceTypes.resources.apptRuleSets.refnums

Type: object

Show Source

• 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

{
    "properties":{
        "apptRefnumQualGid":{
            "description":"The appointment reference number qualifier. The qualifier related to shipment is used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "apptRefnumValue":{
            "description":"The appointment reference number value.",
            "type":"string"
        },
        "isCompatible":{
            "description":"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.<br>If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.<br>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.<br>Shipment Reference Number Qualifier and Value<br>Appointment Rule Set Reference Number Qualifier and Value<br>Q1 V1 Q1 V1, selected<br>Q2 V2 Q2 V2, selected<br>Q3 V3  <br>Q4 V4  <br>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.  <br>To define shipment reference numbers constraints, enter or select the following fields, which are optional:<br>Reference Number Qualifier ID.<br>Reference Number.",
            "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