Jump to

• Request
• Response
• Examples

Update a Product Family Action

put

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}

Use this endpoint to update the specified Product Family action.

Request

Supported Media Types

• application/json

Path Parameters

• actionVarName(required): string
  Variable Name of the Config Action
• allProdFamsVarName(required): string
  Variable Name
• prodFamVarName(required): string
  Variable Name

Body ()

Root Schema : Configuration Actions

Type: object

Title: Configuration Actions

Show Source

• 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 Config Action
• label: string
  Title: Action Name

  Name of the Config Action
• refType: object Reference Type
  Title: Reference Type

  Type of the Reference
• status: object Config Action Status
  Title: Config Action Status

  Status of Config Action
• variableName: string
  Title: Variable Name

  Variable Name of the Config Action

{
    "type":"object",
    "properties":{
        "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 Config Action",
            "title":"Description"
        },
        "label":{
            "type":"string",
            "description":"Name of the Config Action",
            "title":"Action Name"
        },
        "refType":{
            "type":"object",
            "description":"Type of the Reference",
            "title":"Reference Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "status":{
            "type":"object",
            "description":"Status of Config Action",
            "title":"Config Action Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Config Action",
            "title":"Variable Name"
        }
    },
    "title":"Configuration Actions"
}

Nested Schema : Reference Type

Type: object

Title: Reference Type

Type of the Reference

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Type of the Reference",
    "title":"Reference Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Config Action Status

Type: object

Title: Config Action Status

Status of Config Action

Show Source

• displayValue: string
  Title: Display Value

  Translated display name of the type for which fixed list of values can be defined.
• id: integer
  Title: Id

  Primary Key of the fixed list of value resource.
• lookupCode: string
  Title: Lookup Code

  Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Status of Config Action",
    "title":"Config Action Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Back to Top

Examples

The following example shows how to update a Product Family action by submitting a PUT request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PUT -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/_actions/selectAllpf

Request Body Sample

{
  "label": "Select All Options",
  "description": "Select all options for the Product Line",
  "variableName": "selectAllpf",
  "status": {
    "lookupCode": "1"
  }
}

Response Status: 204

Back to Top