Jump to

• Request
• Response

Get a Reference Number

get

/shipmentGroups/{shipGroupGid}/refnums/{shipGroupRefnumQualGidxshipGroupRefnumValue}

Request

Path Parameters

• shipGroupGid(required): string
  Resource ID
• shipGroupRefnumQualGidxshipGroupRefnumValue(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 : shipmentGroups.refnums

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• shipGroupRefnumQualGid: string
  Reference qualiifer.
• shipGroupRefnumValue: string
  Reference value.

{
    "properties":{
        "shipGroupRefnumQualGid":{
            "description":"Reference qualiifer.",
            "type":"string"
        },
        "shipGroupRefnumValue":{
            "description":"Reference value.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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