Jump to

• Request
• Response

Get Package Reference Units

get

/items/{itemGid}/packagedItems/{packagedItemGid}/packageRefUnits

Request

Path Parameters

• itemGid(required): string
  Resource ID
• packagedItemGid(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/items.packagedItems.packageRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items.packagedItems.packageRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/items.packagedItems.packageRefUnits"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : items.packagedItems.packageRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• innerPackCount: number (double)
  Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.
• links: array links
  Read Only: true
• packagingUnitGid: string
  The GID for the packaged unit.

{
    "properties":{
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "innerPackCount":{
            "description":"Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.",
            "type":"number",
            "format":"double"
        },
        "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