Jump to

• Request
• Response

Get a Commoditie

get

/commodities/{commodityGid}

Request

Path Parameters

• commodityGid(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

• commodityDescription: string
  No description.
• commodityGid: string
  No description.
• commodityName: string
  No description.
• commodityXid: string
  No description.
• domainName: string
  No description.
• incompatibilities: incompatibilities
• insertDate: insertDate
  Read Only: true

  insert date
• isTempControl: boolean
  No description.
• links: array links
  Read Only: true
• modeProfileGid: string
  No description.
• reqEqpmtGroupProfileGid: string
  No description.
• temperatureControlGid: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "commodityGid":{
            "description":"No description.",
            "type":"string"
        },
        "commodityXid":{
            "description":"No description.",
            "type":"string"
        },
        "commodityName":{
            "description":"No description.",
            "type":"string"
        },
        "temperatureControlGid":{
            "description":"No description.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "isTempControl":{
            "description":"No description.",
            "type":"boolean"
        },
        "reqEqpmtGroupProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "commodityDescription":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "incompatibilities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/commodities.incompatibilities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : incompatibilities

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/commodities.incompatibilities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object commodities.incompatibilities

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/commodities.incompatibilities"
    }
}

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 : commodities.incompatibilities

Type: object

Show Source

• commodityGid2: string
  No description.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "commodityGid2":{
            "description":"No description.",
            "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"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Back to Top