Get Obstructions
get
/equipmentGroups/{equipmentGroupGid}/obstructions
Request
Path Parameters
-
equipmentGroupGid(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 : equipmentGroups.obstructions
Type:
Show Source
object
-
compartmentNum: number
(int32)
The equipment compartment number for which the obstruction is being defined.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obstrHeight:
obstrHeight
The height coordinate for the obstruction.
-
obstrLength:
obstrLength
The length of the obstruction.
-
obstructionName: string
Name given to obstruction.
-
obstructionNum: number
(int32)
Number identifier for the obstruction.
-
obstrWidth:
obstrWidth
The width of the obstruction.
-
startHeightPosition:
startHeightPosition
The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
-
startLengthPosition:
startLengthPosition
The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
-
startWidthPosition:
startWidthPosition
The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Nested Schema : startHeightPosition
The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Match All
Show Source
Nested Schema : startLengthPosition
The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Match All
Show Source
Nested Schema : startWidthPosition
The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount