Jump to

• Request
• Response

Get a Consol Group

get

/consolGroups/{consolGroupGid}

Request

Path Parameters

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

• consolGroupGid: string
  The GID for the consol_group.
• consolGroupXid: string
  The XID for the consol_group.
• domainName: string
  No description.
• equipmentReferenceUnitGid: string
  The GID for the equipment reference unit being defined.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• maxNumEquipment: number (int32)
  Maximum number of equipment for all the consols with this consol group.
• maxNumReferenceUnits: number (double)
  Maximum number of equipment reference units for all the consols with this consol group.
• maxVolume: maxVolume
  Maximum volume for all the consols with this consol group.
• maxWeight: maxWeight
  Maximum weight for all the consols with this consol group.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "consolGroupGid":{
            "description":"The GID for the consol_group.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "consolGroupXid":{
            "description":"The XID for the consol_group.",
            "type":"string"
        },
        "maxNumEquipment":{
            "description":"Maximum number of equipment for all the consols with this consol group.",
            "type":"number",
            "format":"int32"
        },
        "maxWeight":{
            "description":"Maximum weight for all the consols with this consol group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Maximum volume for all the consols with this consol group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "equipmentReferenceUnitGid":{
            "description":"The GID for the equipment reference unit being defined.",
            "type":"string"
        },
        "maxNumReferenceUnits":{
            "description":"Maximum number of equipment reference units for all the consols with this consol group.",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

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 : maxVolume

Maximum volume for all the consols with this consol group.

Match All

Maximum volume for all the consols with this consol group.

Show Source

• object amountType

{
    "description":"Maximum volume for all the consols with this consol group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Maximum weight for all the consols with this consol group.

Match All

Maximum weight for all the consols with this consol group.

Show Source

• object amountType

{
    "description":"Maximum weight for all the consols with this consol group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

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"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Back to Top