Jump to

• Request
• Response
• Examples

Get a Model Catalog Definition

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}

Use this endpoint to retrieve a catalog definition for the specified Model.

Request

Supported Media Types

• application/json

Path Parameters

• allProdFamsVarName(required): string
  Variable Name of All Product Families '_allProductFamilies'
• modelVarName(required): string
  Variable Name of the Model.
• prodFamVarName(required): string
  Variable Name of the Product Family.
• prodLineVarName(required): string
  Variable Name of the Product Line

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Models

Type: object

Title: Models

Show Source

• companyId: integer
  Title: Company Id

  Id Of Company
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• description: string
  Title: Description

  Description of the Product Line
• id: integer
  Title: Id

  Primary Key Of The Resource
• label: string
  Title: Model Name

  Name of the Model
• parentId: integer
  Title: Parent Id

  Id of immediate parent
• variableName: string
  Title: Variable Name

  Variable Name of the Product Line

{
    "type":"object",
    "properties":{
        "companyId":{
            "type":"integer",
            "description":"Id Of Company",
            "title":"Company Id"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "description":{
            "type":"string",
            "description":"Description of the Product Line",
            "title":"Description"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key Of The Resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Model",
            "title":"Model Name"
        },
        "parentId":{
            "type":"integer",
            "description":"Id of immediate parent",
            "title":"Parent Id"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Product Line",
            "title":"Variable Name"
        }
    },
    "title":"Models"
}

Back to Top

Examples

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

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet

Response Body Sample

{
  "companyId": 4118171,
  "variableName": "internet",
  "description": "<img src=\"$BASE_PATH$/images/Internet.png \" alt=\"Internet\" /></br>\nStay connected with unbelievable download speeds",
  "dateModified": "2020-05-04T16:32:27.000Z",
  "id": 38073912,
  "label": "Unity Internet",
  "dateAdded": "2019-07-30T12:42:41.000Z",
  "parentId": 36732586,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet"
    }, {
      "kind": "",
      "rel": "child",
      "name": "attributes",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet/attributes"
    }, {
      "kind": "",
      "rel": "child",
      "name": "bomMappingRules",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet/bomMappingRules"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices"
    }
  ]
}

Back to Top