Get Resource Types
get
/locations/{locationGid}/resourceTypes
Request
Path Parameters
-
locationGid(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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : locations.resourceTypes
Type:
Show Source
object
-
autoScheduleAppointment: boolean
Indicate whether appointment should be automatically scheduled for the resource type.
-
calendarGid: string
The calendar GID that applies to the location resource type.
-
constraintAppointment: boolean
Whether the location resource type constraints scheduling appointments.
-
description: string
The description of the location resource type.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
resources:
resources
-
resourceTypeGid: string
Resource Type GID for the location.
Nested Schema : resources
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources
Type:
Show Source
object
-
appointmentActivityType: string
Specify if the trailer that is scheduled for the appointment is attached to the truck by selecting Live from the Appointment Activity Type field. If the trailer is being dropped off, select Drop.
-
apptRuleSets:
apptRuleSets
-
calendarGid: string
The calendar GID that will be applied to the resource.
-
contactProfileGid: string
The contact profile GID.
-
description: string
The description of the resource.
-
domainName: string
Database domain where this data is stored.
-
equipmentGroupProfileGid: string
The equipment group profile ID that associates to the location resource.
-
flexCommodityCheckOption: string
Flex Commodify check option, such as CHECK ALL, CHECK BY LARGEST WEIGHT and CHECK BY LARGEST VOLUME.
-
flexCommodityProfileGid: string
The flex commodity profile ID that associates to the location resource.
-
links: array
links
Read Only:
true
-
locationResourceGid: string
The location resource GID.
-
locationResourceGroupGid: string
The XID for the location resource group. A location resource group allows you to group location resources such as dock door1, dock door2, and dock door3 into a location resource group such as frozen goods into a group called frozen. Similarly, you can group location resources into a location resource group such as dry goods into a group called dry. While you create a location resource group, you can also assign locations. For each location, you can assign multiple appointment rule sets. These rules sets are applicable to all the resources which are under the location resource group. A location resource group enables you to avoid duplicate configurations for each resource.
-
locationResourceName: string
The name of the resource.
-
locationResourceXid: string
The XID of the location resource.
-
modeProfileGid: string
The mode profile ID that associates to the location resource.
-
preferenceLevel: number
(int32)
Gets the preference level of resource for Appointment scheduling
-
servprovProfileGid: string
The service provider profile ID that associates to the location resource.
Nested Schema : apptRuleSets
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : locations.resourceTypes.resources.apptRuleSets
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