Jump to

• Request
• Response
• Examples

Get Model Array Set Metadata

get

/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/arraySets/{arraySetVarName}

This service returns the metadata for a specific array set of a Model.

Request

Path Parameters

• arraySetVarName(required): string
  Array Set variable name.
• modelVarName(required): string
  Model variable name.
• prodFamVarName(required): string
  Product family variable name.
• prodLineVarName(required): string
  Product line variable name.

Query Parameters

• excludeLinks: string
  Exclude links.
• expand: string
  Allows expansion of relationships.
• showParentAttrs: string
  Allows expansion of parent attributes.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Array set defined at model level.

Body ()

Root Schema : arraySet

Type: object

Show Source

• defaultAttrId: integer
  Title: Default Attribute Id

  Default attribute id.
• desc: string
  Title: Desc

  Desc.
• displayType: object displayType
• id: integer
  Title: Id

  Primary key of the array set.
• labelOption: object labelOption
• links: object Reference Links
  Title: Reference Links

  Reference links for the Parent, Self, Children and Related as applicable
• name: string
  Title: The Name Schema

  An explanation about the purpose of this instance.
• prefixText: string
  Title: Prefix Text

  Prefix text.
• refType: integer
  Title: Ref Type

  Ref type.
• sizeAttrId: integer
  Title: Size Attribute Id

  Size attribute id.
• sizeAttrVarName: string
  Title: Size Attribute variable name

  Size attribute variable name.
• suffixText: string
  Title: Suffix Text

  Suffix text.
• VarName: string
  Title: Name

  Unique variable name to identify the array set.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary key of the array set.",
            "title":"Id"
        },
        "refType":{
            "type":"integer",
            "description":"Ref type.",
            "title":"Ref Type"
        },
        "name":{
            "type":"string",
            "description":"An explanation about the purpose of this instance.",
            "title":"The Name Schema "
        },
        "VarName":{
            "type":"string",
            "description":"Unique variable name to identify the array set.",
            "title":"Name"
        },
        "desc":{
            "type":"string",
            "description":"Desc.",
            "title":"Desc"
        },
        "sizeAttrId":{
            "type":"integer",
            "description":"Size attribute id.",
            "title":"Size Attribute Id"
        },
        "sizeAttrVarName":{
            "type":"string",
            "description":"Size attribute variable name.",
            "title":"Size Attribute variable name"
        },
        "defaultAttrId":{
            "type":"integer",
            "description":"Default attribute id.",
            "title":"Default Attribute Id"
        },
        "displayType":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Lookup code.",
                    "title":"Lookup Code"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Display value.",
                    "title":"Display Value"
                }
            }
        },
        "labelOption":{
            "type":"object",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Lable option.",
                    "title":"Label Option"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Display value.",
                    "title":"Display Value"
                }
            }
        },
        "prefixText":{
            "type":"string",
            "description":"Prefix text.",
            "title":"Prefix Text"
        },
        "suffixText":{
            "type":"string",
            "description":"Suffix text.",
            "title":"Suffix Text"
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : displayType

Type: object

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• lookupCode: string
  Title: Lookup Code

  Lookup code.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Lookup code.",
            "title":"Lookup Code"
        },
        "displayValue":{
            "type":"string",
            "description":"Display value.",
            "title":"Display Value"
        }
    }
}

Nested Schema : labelOption

Type: object

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• lookupCode: string
  Title: Label Option

  Lable option.

{
    "type":"object",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Lable option.",
            "title":"Label Option"
        },
        "displayValue":{
            "type":"string",
            "description":"Display value.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Reference Links

Type: object

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: href

  URL to the related object
• rel: string
  Title: Link

  Link relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relationship to the current object",
            "title":"Link"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"href"
        }
    },
    "title":"Reference Links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example shows how to retrieve the metadata for the specified Configuration item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage/arraySets/_setapplicationSoftware

Translations

The following components can be appended to the end of this endpoint to return translation metadata:

• /translations - This returns all language translations for the requested entity.
• /translations/{langCode} - This returns a specific language translation for the requested entity. Example: /translations/es

Response Body Sample

{
  "id": 36673355,
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware/translations"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets/_setapplicationSoftware/attributes"
    }
  ],
  "refType": 3,
  "name": "Application Software",
  "variableName": "_setapplicationSoftware",
  "desc": "",
  "sizeAttrId": 36673055,
  "defaultAttrId": -1,
  "displayType": {
    "lookupCode": "1",
    "displayValue": "Horizontal"
  },
  "labelOption": {
    "lookupCode": "1",
    "displayValue": "Display Only First Label"
  },
  "prefixText": "",
  "suffixText": ""
}

Back to Top