Jump to

• Request
• Response

Get a Load Unload Point

get

/locations/{locationGid}/loadUnloadPoints/{loadUnloadPoint}

Request

Path Parameters

• loadUnloadPoint(required): string
  Resource ID
• 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.

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

• description: string
  Description for the load/unload point.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupProfileGid: string
  Equipment group profile for the load/unload point; overrides any at the location.
• isLoad: boolean
  Indicates if this dock or point make be used for loading.
• isUnload: boolean
  Indicates if this dock or point make be used for loading.
• links: array links
  Read Only: true
• loadSequence: number (int32)
  Indicates where dock should be in a load sequence.
• loadUnloadPoint: string
  Load/unload point such as a loading dock.
• unloadSequence: number (int32)
  Indicates where dock should be in an unload sequence.

{
    "properties":{
        "loadUnloadPoint":{
            "description":"Load/unload point such as a loading dock.",
            "type":"string"
        },
        "description":{
            "description":"Description for the load/unload point.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"Equipment group profile for the load/unload point; overrides any at the location.",
            "type":"string"
        },
        "isLoad":{
            "description":"Indicates if this dock or point make be used for loading.",
            "type":"boolean"
        },
        "loadSequence":{
            "description":"Indicates where dock should be in a load sequence.",
            "type":"number",
            "format":"int32"
        },
        "isUnload":{
            "description":"Indicates if this dock or point make be used for loading.",
            "type":"boolean"
        },
        "unloadSequence":{
            "description":"Indicates where dock should be in an unload sequence.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "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"
        }
    }
}

Back to Top