1. REST API Services for Oracle CPQ
  2. Tasks
  3. Groups

Update Group Access Segments for a Group

patch

/rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments

This endpoint updates access segments for an existing group but does not require sending the entire body with the request.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Segments
Type: object
Title: Segments
Access Segments for a group
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Segment Details
Type: object
Title: Segment Details
Show Source
  • Title: Checked
    Is segment enabled.
  • Title: Icon
    Path of the icon image file. This field is only applicable if uiMetadata is set as true.
  • Sub Segments
    Title: Sub Segments
    Sub access segments for the segment.
  • Title: Status
    Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.
  • Title: VariableName
    Segment variable name.
Nested Schema : Sub Segments
Type: object
Title: Sub Segments
Sub access segments for the segment.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Sub Segment Details
Type: object
Title: Sub Segment Details
Show Source
  • Title: Checked
    Is segment enabled.
  • Title: Icon
    Path of the icon image file. This field is only applicable if uiMetadata is set as true.
  • Title: Status
    Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.
  • Title: title
    Segment label.
  • Title: VariableName
    Segment variable name.
Back to Top

Response

Supported Media Types

Default Response

Group access segment details.
Body ()
Root Schema : Segments
Type: object
Title: Segments
Access Segments for a group
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Segment Details
Type: object
Title: Segment Details
Show Source
  • Title: Checked
    Is segment enabled.
  • Title: Icon
    Path of the icon image file. This field is only applicable if uiMetadata is set as true.
  • Sub Segments
    Title: Sub Segments
    Sub access segments for the segment.
  • Title: Status
    Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.
  • Title: VariableName
    Segment variable name.
Nested Schema : Sub Segments
Type: object
Title: Sub Segments
Sub access segments for the segment.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Sub Segment Details
Type: object
Title: Sub Segment Details
Show Source
  • Title: Checked
    Is segment enabled.
  • Title: Icon
    Path of the icon image file. This field is only applicable if uiMetadata is set as true.
  • Title: Status
    Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true.
  • Title: title
    Segment label.
  • Title: VariableName
    Segment variable name.
Back to Top

Examples

The following example updates access segments for an existing group with information provided in the web services request by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PATCH -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/companies/visionServices/groups/midwestTestGroup/segments

Request Body Sample

{
  "items": [{
      "variableName": "_developerTools",
      "segments": {
        "items": [{
            "variableName": "_dataTables",
            "checked": false,
            "segments": {
              "items": [{
                  "variableName": "aBOTables",
                  "checked": false
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

Response Body Sample

{
  "items": [{
      "variableName": "_commerceAndDocuments",
      "title": "Commerce and Documents",
      "checked": false,
      "segments": {
        "items": [{
            "variableName": "_processDefinition",
            "title": "Process Definition",
            "checked": true
          }, {
            "variableName": "_processInvocation",
            "title": "Process Invocation",
            "checked": true
          }, {
            "variableName": "_commerceSettings",
            "title": "Commerce Settings",
            "checked": true
          }, {
            "variableName": "_documents",
            "title": "Documents",
            "checked": true
          }, {
            "variableName": "_documentDesigner",
            "title": "Document Designer",
            "checked": false
          }, {
            "variableName": "_emailDesigner",
            "title": "Email Designer",
            "checked": false
          }
        ]
      }
    }, {
      "variableName": "_developerTools",
      "title": "Developer Tools",
      "checked": false,
      "segments": {
        "items": [{
            "variableName": "_bmlLibrary",
            "title": "BML Library",
            "checked": false
          }, {
            "variableName": "_dataTables",
            "title": "Data Tables",
            "checked": false,
            "segments": {
              "items": [{
                  "variableName": "_default",
                  "title": "[Default]",
                  "checked": true
                }, {
                  "variableName": "aBOTables",
                  "title": "ABO Tables",
                  "checked": false
                }, {
                  "variableName": "accessRestrictedFolder",
                  "title": "Access Restricted Folder",
                  "checked": false
                }, {
                  "variableName": "bMQL",
                  "title": "BMQL",
                  "checked": false
                }, {
                  "variableName": "bOMTables",
                  "title": "BOM Tables",
                  "checked": false
                }, {
                  "variableName": "commerce",
                  "title": "Commerce",
                  "checked": false
                }, {
                  "variableName": "configuration",
                  "title": "Configuration",
                  "checked": false
                }, {
                  "variableName": "dataTables",
                  "title": "Data Tables",
                  "checked": false
                }, {
                  "variableName": "formulaManagement",
                  "title": "Formula Management",
                  "checked": false
                }, {
                  "variableName": "integration",
                  "title": "Integration",
                  "checked": false
                }, {
                  "variableName": "sOAP",
                  "title": "SOAP",
                  "checked": false
                }
              ]
            }
          }, {
            "variableName": "_globalSearchOnBML",
            "title": "Global Search on BML",
            "checked": false
          }, {
            "variableName": "_devToolKit",
            "title": "Developer Toolkit CLI",
            "checked": false
          }, {
            "variableName": "_logs",
            "title": "Logs",
            "checked": false
          }
        ]
      }
    }, {
      "variableName": "_integrationPlatform",
      "title": "Integration Platform",
      "checked": false,
      "segments": {
        "items": [{
            "variableName": "_accounts",
            "title": "Accounts",
            "checked": false
          }, {
            "variableName": "_integrationSettings",
            "title": "Integration Settings",
            "checked": false
          }, {
            "variableName": "_singleSignOn",
            "title": "Single Sign-On",
            "checked": false
          }, {
            "variableName": "_webServices",
            "title": "Web Services",
            "checked": false
          }, {
            "variableName": "_interfaceCatalogs",
            "title": "Interface Catalogs",
            "checked": false
          }, {
            "variableName": "_integrationCenter",
            "title": "Integration Center",
            "checked": false
          }
        ]
      }
    }, {
      "variableName": "_general",
      "title": "General",
      "checked": true,
      "segments": {
        "items": [{
            "variableName": "_uiDesigner",
            "title": "UI Designer",
            "checked": true
          }, {
            "variableName": "_countriesAndStates",
            "title": "Countries and States",
            "checked": true
          }, {
            "variableName": "_emailSignature",
            "title": "Email Signature",
            "checked": true
          }, {
            "variableName": "_favoritesList",
            "title": "Favorites List",
            "checked": true
          }, {
            "variableName": "_generalSiteOptions",
            "title": "General Site Options",
            "checked": true
          }, {
            "variableName": "_hostCompany",
            "title": "Host Company",
            "checked": true
          }
        ]
      }
    }, {
      "variableName": "_products",
      "title": "Products",
      "checked": false,
      "segments": {
        "items": [{
            "variableName": "_productDefinition",
            "title": "Product Definition",
            "checked": false,
            "segments": {
              "items": [{
                  "variableName": "visionVehicles",
                  "title": "Vision Vehicles",
                  "checked": false
                }, {
                  "variableName": "systemConfigurationProductFamily",
                  "title": "System Configuration Product Family",
                  "checked": false
                }, {
                  "variableName": "integration",
                  "title": "Integration",
                  "checked": false
                }, {
                  "variableName": "admin",
                  "title": "Admin",
                  "checked": false
                }, {
                  "variableName": "test5",
                  "title": "Test 5",
                  "checked": false
                }, {
                  "variableName": "test4",
                  "title": "Test 4",
                  "checked": false
                }, {
                  "variableName": "test3",
                  "title": "Test 3",
                  "checked": false
                }, {
                  "variableName": "test2",
                  "title": "Test 2",
                  "checked": false
                }, {
                  "variableName": "test1",
                  "title": "Test 1",
                  "checked": false
                }, {
                  "variableName": "unsupported",
                  "title": "Unsupported",
                  "checked": false
                }, {
                  "variableName": "testbed",
                  "title": "Testbed",
                  "checked": false
                }
              ]
            }
          }, {
            "variableName": "_catalogDefinition",
            "title": "Catalog Definition",
            "checked": false,
            "segments": {
              "items": [{
                  "variableName": "admin",
                  "title": "Admin",
                  "checked": false
                }, {
                  "variableName": "integration",
                  "title": "Integration",
                  "checked": false
                }, {
                  "variableName": "systemConfigurationProductFamily",
                  "title": "System Configuration Product Family",
                  "checked": false
                }, {
                  "variableName": "test1",
                  "title": "Test 1",
                  "checked": false
                }, {
                  "variableName": "test2",
                  "title": "Test 2",
                  "checked": false
                }, {
                  "variableName": "test3",
                  "title": "Test 3",
                  "checked": false
                }, {
                  "variableName": "test4",
                  "title": "Test 4",
                  "checked": false
                }, {
                  "variableName": "test5",
                  "title": "Test 5",
                  "checked": false
                }, {
                  "variableName": "testbed",
                  "title": "Testbed",
                  "checked": false
                }, {
                  "variableName": "visionVehicles",
                  "title": "Vision Vehicles",
                  "checked": false
                }
              ]
            }
          }, {
            "variableName": "_configurationSettings",
            "title": "Configuration Settings",
            "checked": false
          }, {
            "variableName": "_parts",
            "title": "Parts",
            "checked": false
          }, {
            "variableName": "_eligibilityRules",
            "title": "Eligibility Rules",
            "checked": false
          }, {
            "variableName": "_pricing",
            "title": "Pricing Portal",
            "checked": false
          }, {
            "variableName": "_bOM",
            "title": "BOM",
            "checked": false
          }, {
            "variableName": "_assets",
            "title": "Assets",
            "checked": false
          }, {
            "variableName": "_productSetups",
            "title": "Product Launch",
            "checked": false
          }
        ]
      }
    }, {
      "variableName": "_styleAndTemplates",
      "title": "Style and Templates",
      "checked": false,
      "segments": {
        "items": [{
            "variableName": "_headerFooter",
            "title": "Header and Footer",
            "checked": false
          }, {
            "variableName": "_homePage",
            "title": "Home Page",
            "checked": false
          }, {
            "variableName": "_homePageFlows",
            "title": "Home Page Flows",
            "checked": false
          }, {
            "variableName": "_pageTemplates",
            "title": "Page Templates",
            "checked": false
          }, {
            "variableName": "_stylesheet",
            "title": "Stylesheet",
            "checked": false
          }
        ]
      }
    }, {
      "variableName": "_users",
      "title": "Users",
      "checked": false,
      "segments": {
        "items": [{
            "variableName": "_internalUsers",
            "title": "Internal Users",
            "checked": false
          }, {
            "variableName": "_groups",
            "title": "Groups",
            "checked": false
          }, {
            "variableName": "_partnerOrganizations",
            "title": "Partner Organizations",
            "checked": false
          }
        ]
      }
    }, {
      "variableName": "_utilities",
      "title": "Utilities",
      "checked": false,
      "segments": {
        "items": [{
            "variableName": "_broadcastEmail",
            "title": "Broadcast Email",
            "checked": false
          }, {
            "variableName": "_migration",
            "title": "Migration",
            "checked": false
          }, {
            "variableName": "_bulkDataServices",
            "title": "Bulk Data Services",
            "checked": false
          }, {
            "variableName": "_fileManager",
            "title": "File Manager",
            "checked": false
          }, {
            "variableName": "_textAdministration",
            "title": "Text Administration",
            "checked": false
          }
        ]
      }
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/midwestTestGroup/segments"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/midwestTestGroup"
    }
  ]
}
Back to Top