Overview
Product Setup endpoints are used to manage product definitions for All Product Families, Product Families, Product Lines, and Models.
Administration
All Product Families
Get All Product Families Setups
|
Description |
Use this endpoint to retrieve the All Product Families product definitions. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups |
|
|
Endpoint Parameters |
None |
|
| Endpoint Query Parameters |
This endpoint supports the following query specifications. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of the All Product Families items. |
|
|
companyId |
Company identifier |
|
|
label |
All product families label |
|
|
variableName |
All product families variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups
{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups" } ], "items": [{ "companyId": 4118171, "variableName": "_allProductFamilies", "label": "All Product Families", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes" }, { "kind": "", "rel": "child", "name": "productFamilies", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies" } ] } ] }
Get an All Product Families Setup
|
Description |
Use this endpoint to retrieve the specified All Product Families product definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName} |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
| Endpoint Query Parameters | (Optional) This endpoint supports the expand query specification, for more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
| Response Body Parameters |
companyId |
Company identifier |
|
label |
All product families label |
|
|
variableName |
All product families variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies
{ "companyId": 4118171, "variableName": "_allProductFamilies", "label": "All Product Families", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes" }, { "kind": "", "rel": "child", "name": "productFamilies", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies" } ] }
Product Family
|
Description |
Use this endpoint to retrieve the specified Product Family product definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName} |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
HTTP Method |
Delete |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to deploy the specified Product Family. Deployments can be scheduled, and users can set up email notifications. Data tables associated with rules can be deployed along with the product family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/actions/deploy |
|
|
Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
dataTables |
(Optional) An array of selected product family related data table variable names. |
|
emailTo |
(Optional) Email address to send a confirmation email. |
|
|
scheduledTime |
(Optional) Time to start the deploy |
|
| Response Body Parameters |
Links to self and the deploy task. |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/testbed/actions/deploy
{ "emailTo": "some@email.address", "scheduledTime": "2024-06-24T18:51:02.000Z", "dataTables": ["dataTable", "otherDataTable", "thirdDataTable"] }
{ "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/testbed/actions/deploy" }, { "rel": "related", "href": "https://sitename.oracle.com/rest/v19/asyncTasks/3022899700/status" } ] }
|
Description |
Use this endpoint to retrieve a list of Product Family product definitions. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies |
|
|
Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
| Endpoint Query Parameters | This endpoint supports the following query specifications.q, expand, fields, limit, offset, orderby, and totalResults, for more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of available Product Family items: |
|
|
activeLayoutType |
Current active layout type |
|
|
companyId |
Company identifier |
|
|
dateAdded |
System field indicating the date on which the resource was created. |
|
|
dateModified |
System field indicating the date on which the resource was last modified. |
|
|
id |
Product family identifier |
|
|
label |
Product family label |
|
|
lastDeployedDate |
Date of the last successful product family deployment. |
|
|
name |
Product family name |
|
|
segmentId |
Segment identifier |
|
|
variableName |
Product family variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies
{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies" } ], "items": [{ "companyId": 4118171, "variableName": "unityINC", "segmentId": 13, "name": "Unity INC", "dateModified": "2021-02-03T17:40:33Z", "id": 36732579, "dateAdded": "2018-11-09T17:24:51Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/attributes" }, { "kind": "", "rel": "child", "name": "productLines", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies" } ] }, { "companyId": 4118171, "variableName": "varioTablets", "segmentId": 10, "name": "Vario Tablets", "dateModified": "2021-02-03T17:40:33Z", "id": 36592821, "dateAdded": "2017-11-09T13:47:13Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/attributes" }, { "kind": "", "rel": "child", "name": "productLines", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/productLines" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies" } ] }, { "companyId": 4118171, "variableName": "visionServices", "segmentId": 11, "name": "Vision Services", "dateModified": "2021-02-03T17:40:33Z", "id": 36592830, "dateAdded": "2017-11-09T13:47:21Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionServices" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionServices/attributes" }, { "kind": "", "rel": "child", "name": "productLines", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionServices/productLines" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies" } ] }, { "companyId": 4118171, "variableName": "visionVehicles", "segmentId": 29, "name": "Vision Vehicles", "dateModified": "2021-09-17T12:29:43Z", "id": 38644483, "dateAdded": "2021-09-17T12:28:09Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/attributes" }, { "kind": "", "rel": "child", "name": "productLines", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies" } ] } ] }
|
Description |
Use this endpoint to retrieve the specified Product Family product definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName} |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
| Endpoint Query Parameters | (Optional) This endpoint supports the expand query specification, for more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
activeLayoutType |
Current active layout type |
|
companyId |
Company identifier |
|
|
dateAdded |
System field indicating the date on which the resource was created. |
|
|
dateModified |
System field indicating the date on which the resource was last modified. |
|
|
id |
Product family identifier |
|
|
label |
Product family label |
|
|
lastDeployedDate |
Date of the last successful product family deployment. |
|
|
name |
Product family name |
|
|
segmentId |
Segment identifier |
|
|
variableName |
Product family variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC
{ "companyId": 4118171, "variableName": "unityINC", "segmentId": 13, "name": "Unity INC", "dateModified": "2021-02-03T17:40:33Z", "id": 36732579, "dateAdded": "2018-11-09T17:24:51Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/attributes" }, { "kind": "", "rel": "child", "name": "productLines", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies" } ] }
|
Description |
Use this endpoint to retrieve a list of undeployed Data Tables related to the specified Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/actions/getRelatedUndeployedDataTables |
|
|
Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
None |
|
| Response Body Parameters |
An array of undeployed Data Tables that are referenced within the product family's table based configuration rules. |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/testbed/actions/getRelatedUndeployedDataTables
{ "undeployedDataTables": ["dataTable", "otherDataTable", "thirdDataTable"] }
|
Description |
Use this endpoint to remove support for the specified Product Family. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/actions/removeSupport |
|
|
Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
None |
|
| Success Response |
200 |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/test4/actions/removeSupport
Product Line
|
Description |
Use this endpoint to retrieve the specified Product Line product definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName} |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
prodLineVarName |
The variable name of a Product Line |
|
|
HTTP Method |
Delete |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve a list of Product Line product definitions. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
| Endpoint Query Parameters | This endpoint supports the following query specifications.q, expand, fields, limit, offset, orderby, and totalResults, for more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of Product Line items. |
|
|
companyId |
Company identifier |
|
|
dateAdded |
System field indicating the date on which the resource was created. |
|
|
dateModified |
System field indicating the date on which the resource was last modified. |
|
|
description |
Product line description |
|
|
id |
Product line identifier |
|
|
label |
Product line label |
|
|
parentId |
Identifier of the immediate parent |
|
|
segmentId |
Segment identifier |
|
|
variableName |
Product line variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines
{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines" } ], "items": [{ "companyId": 4118171, "variableName": "standAloneServices", "segmentId": 13, "description": null, "dateModified": "2020-05-04T16:32:27.000Z", "id": 36732586, "label": "Stand Alone Services", "dateAdded": "2018-11-09T17:27:10.000Z", "parentId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/attributes" }, { "kind": "", "rel": "child", "name": "models", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC" } ] }, { "companyId": 4118171, "variableName": "mergedServices", "segmentId": 13, "description": null, "dateModified": "2020-05-04T16:32:27.000Z", "id": 38073908, "label": "Merged Services", "dateAdded": "2019-07-30T12:42:41.000Z", "parentId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/mergedServices" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/mergedServices/attributes" }, { "kind": "", "rel": "child", "name": "models", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/mergedServices/models" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC" } ] } ] }
|
Description |
Use this endpoint to retrieve the specified Product Line product definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName} |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
prodLineVarName |
The variable name of a Product Line |
|
| Endpoint Query Parameters | (Optional) This endpoint supports the expand query specification, for more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
companyId |
Company identifier |
|
dateAdded |
System field indicating the date on which the resource was created. |
|
|
dateModified |
System field indicating the date on which the resource was last modified. |
|
|
description |
Product line description |
|
|
id |
Product line identifier |
|
|
label |
Product line label |
|
|
parentId |
Identifier of the immediate parent |
|
|
segmentId |
Segment identifier |
|
|
variableName |
Product line variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices
{ "companyId": 4118171, "variableName": "standAloneServices", "segmentId": 13, "description": null, "dateModified": "2020-05-04T16:32:27.000Z", "id": 36732586, "label": "Stand Alone Services", "dateAdded": "2018-11-09T17:27:10.000Z", "parentId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/attributes" }, { "kind": "", "rel": "child", "name": "models", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC" } ] }
Model
|
Description |
Use this endpoint to retrieve the specified Product Line product definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName} |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
|
HTTP Method |
Delete |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve a list of Model product definitions. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
prodLineVarName |
The variable name of a Product Line |
|
| Endpoint Query Parameters | This endpoint supports the following query specifications.q, expand, fields, limit, offset, orderby, and totalResults, for more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of Model items. |
|
|
companyId |
Company identifier |
|
|
dateAdded |
System field indicating the date on which the resource was created. |
|
|
dateModified |
System field indicating the date on which the resource was last modified. |
|
|
description |
Model description |
|
|
id |
Model identifier |
|
|
label |
Model label |
|
|
parentId |
Identifier of the immediate parent |
|
|
segmentId |
Segment identifier |
|
|
variableName |
Model variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models
{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models" } ], "items": [{ "companyId": 4118171, "variableName": "mobility", "description": "<img src=\"$BASE_PATH$/images/Mobility.png \" alt=\"Mobility\" /></br>\nSelect the Mobile Services that are right for you", "dateModified": "2020-05-04T16:32:27.000Z", "id": 36732594, "label": "Unity Mobility", "dateAdded": "2018-11-09T17:31:43.000Z", "parentId": 36732586, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/mobility" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/mobility/attributes" }, { "kind": "", "rel": "child", "name": "bomMappingRules", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/mobility/bomMappingRules" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices" } ] }, { "companyId": 4118171, "variableName": "home", "description": "<img src=\"$BASE_PATH$/images/Home_Security.png \" alt=\"Home\" /></br>\nSmart Home offerings to keep your family secure", "dateModified": "2020-05-04T16:32:27.000Z", "id": 38073910, "label": "Unity Home", "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/home" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/home/attributes" }, { "kind": "", "rel": "child", "name": "bomMappingRules", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/home/bomMappingRules" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices" } ] }, { "companyId": 4118171, "variableName": "entertainment", "description": "<img src=\"$BASE_PATH$/images/Entertainment.png \" alt=\"Entertainment\" /></br>\nMovies, Streaming Services, Television, Games and More", "dateModified": "2020-05-04T16:32:27.000Z", "id": 38073911, "label": "Unity Entertainment", "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/entertainment" }, { "kind": "", "rel": "child", "name": "attributes", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/entertainment/attributes" }, { "kind": "", "rel": "child", "name": "bomMappingRules", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/entertainment/bomMappingRules" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices" } ] }, { "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" } ] } ] }
|
Description |
Use this endpoint to retrieve the specified Model product definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName} |
|
| Endpoint Parameters |
allProdFamsVarName |
The variable name of All Product Families ( |
|
prodFamVarName |
The variable name of a Product Family |
|
|
prodLineVarName |
The variable name of a Product Line |
|
|
modelVarName |
The variable name of a Model |
|
| Endpoint Query Parameters | (Optional) This endpoint supports the expand query specification, for more information, see Manage Collections. |
|
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
companyId |
Company identifier |
|
dateAdded |
System field indicating the date on which the resource was created. |
|
|
dateModified |
System field indicating the date on which the resource was last modified. |
|
|
description |
Model description |
|
|
id |
Model identifier |
|
|
label |
Model label |
|
|
parentId |
Identifier of the immediate parent |
|
|
segmentId |
Segment identifier |
|
|
variableName |
Model variable name |
|
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet
{ "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" } ] }
