Jump to

• Request
• Response
• Examples

Deploy a Product Family

post

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/actions/deploy

Use this endpoint to deploy a Product Family.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Root Schema : Product Family Setup Deploy Request Definitions

Type: object

Title: Product Family Setup Deploy Request Definitions

Show Source

• dataTables: array Selected Data Table Variable Names
  Title: Selected Data Table Variable Names

  List of selected product family related data table variable names
• emailTo: string
  Title: Email To

  Optional email address to send a confirmation email.
• scheduledTime: string
  Title: Scheduled Time

  Optional time to start the deploy.

{
    "type":"object",
    "properties":{
        "dataTables":{
            "$ref":"#/definitions/dataTables"
        },
        "scheduledTime":{
            "type":"string",
            "description":"Optional time to start the deploy.",
            "title":"Scheduled Time"
        },
        "emailTo":{
            "type":"string",
            "description":"Optional email address to send a confirmation email.",
            "title":"Email To"
        }
    },
    "title":"Product Family Setup Deploy Request Definitions"
}

Nested Schema : Selected Data Table Variable Names

Type: array

Title: Selected Data Table Variable Names

List of selected product family related data table variable names

Show Source

• Array of: string

{
    "title":"Selected Data Table Variable Names",
    "type":"array",
    "description":"List of selected product family related data table variable names",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Product Family Setup Deploy Response Definitions

Type: object

Title: Product Family Setup Deploy Response Definitions

Show Source

• links: array links
  Title: links

  links

{
    "type":"object",
    "properties":{
        "links":{
            "$ref":"#/definitions/configDeployLinks"
        }
    },
    "title":"Product Family Setup Deploy Response Definitions"
}

Nested Schema : links

Type: array

Title: links

links

Show Source

• Array of: string

{
    "title":"links",
    "type":"array",
    "description":"links",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

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

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/testbed/actions/deploy

Request Body Sample

{
  "emailTo": "[e-mail]",
  "scheduledTime": "2024-06-24T18:51:02.000Z",
  "dataTables": ["dataTable", "otherDataTable", "thirdDataTable"]
}

Response Body Sample

{
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/allProductFamilySetups/_allProductFamilies/productFamilies/testbed/actions/deploy"
    }, {
      "rel": "related",
      "href": "https://sitename.oracle.com/asyncTasks/3022899700/status"
    }
  ]
}

Back to Top