Jump to

• Request
• Response
• Examples

Create a Group for Host Company or Partner Organization

post

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

This endpoint create a group for the host company and partner organization based on logged in users.

Request

Supported Media Types

• application/json

Path Parameters

• companyLoginName(required): string
  Company login name.

Body ()

Root Schema : Group Details

Type: object

Title: Group Details

Show Source

• description: string
  Title: Description

  Description of the group.
• label(required): string
  Title: Label

  Name of the group.
• segments: object Segments
  Title: Segments

  Access Segments for the group.
• status: object Status
  Title: Status

  Preferred status format of the group.
• type(required): object Type
  Title: Type

  Preferred type format of the group.
• users: object Selected Users
  Title: Selected Users

  The users list part of the group.
• variableName(required): string
  Title: VariableName

  Variable name of the group.

{
    "type":"object",
    "required":[
        "label",
        "type",
        "variableName"
    ],
    "properties":{
        "label":{
            "type":"string",
            "description":"Name of the group.",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name of the group.",
            "title":"VariableName"
        },
        "description":{
            "type":"string",
            "description":"Description of the group.",
            "title":"Description"
        },
        "type":{
            "type":"object",
            "description":"Preferred type format of the group.",
            "title":"Type",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            },
            "required":[
                "value"
            ]
        },
        "status":{
            "type":"object",
            "description":"Preferred status format of the group.",
            "title":"Status",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            },
            "required":[
                "value"
            ]
        },
        "users":{
            "type":"object",
            "description":"The users list part of the group.",
            "title":"Selected Users",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/groupUsers"
                    }
                }
            }
        },
        "segments":{
            "type":"object",
            "description":"Access Segments for the group.",
            "title":"Segments",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/accessSegments"
                    }
                }
            }
        }
    },
    "title":"Group Details"
}

Nested Schema : Segments

Type: object

Title: Segments

Access Segments for the group.

Show Source

• items: array items

{
    "type":"object",
    "description":"Access Segments for the group.",
    "title":"Segments",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/accessSegments"
            }
        }
    }
}

Nested Schema : Status

Type: object

Title: Status

Preferred status format of the group.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value(required): number
  Title: Value

  Value

{
    "type":"object",
    "description":"Preferred status format of the group.",
    "title":"Status",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    },
    "required":[
        "value"
    ]
}

Nested Schema : Type

Type: object

Title: Type

Preferred type format of the group.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value(required): number
  Title: Value

  Value

{
    "type":"object",
    "description":"Preferred type format of the group.",
    "title":"Type",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    },
    "required":[
        "value"
    ]
}

Nested Schema : Selected Users

Type: object

Title: Selected Users

The users list part of the group.

Show Source

• items: array items

{
    "type":"object",
    "description":"The users list part of the group.",
    "title":"Selected Users",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/groupUsers"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Segment Details
  Title: Segment Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/accessSegments"
    }
}

Nested Schema : Segment Details

Type: object

Title: Segment Details

Show Source

• checked: boolean
  Title: Checked

  Is segment enabled.
• icon: string
  Title: Icon

  Path of the icon image file. This field is only applicable if uiMetadata is set as true.
• segments: object Sub Segments
  Title: Sub Segments

  Sub access segments for the segment.
• status: integer
  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.
• variableName(required): string
  Title: VariableName

  Segment variable name.

{
    "type":"object",
    "required":[
        "variableName"
    ],
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Segment variable name.",
            "title":"VariableName"
        },
        "checked":{
            "type":"boolean",
            "description":"Is segment enabled.",
            "title":"Checked"
        },
        "icon":{
            "type":"string",
            "description":"Path of the icon image file. This field is only applicable if uiMetadata is set as true.",
            "title":"Icon"
        },
        "status":{
            "type":"integer",
            "description":"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":"Status"
        },
        "segments":{
            "type":"object",
            "description":"Sub access segments for the segment.",
            "title":"Sub Segments",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/subSegmentAccess"
                    }
                }
            }
        }
    },
    "title":"Segment Details"
}

Nested Schema : Sub Segments

Type: object

Title: Sub Segments

Sub access segments for the segment.

Show Source

• items: array items

{
    "type":"object",
    "description":"Sub access segments for the segment.",
    "title":"Sub Segments",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/subSegmentAccess"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Sub Segment Details
  Title: Sub Segment Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/subSegmentAccess"
    }
}

Nested Schema : Sub Segment Details

Type: object

Title: Sub Segment Details

Show Source

• checked: boolean
  Title: Checked

  Is segment enabled.
• icon: string
  Title: Icon

  Path of the icon image file. This field is only applicable if uiMetadata is set as true.
• status: integer
  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: string
  Title: title

  Segment label.
• variableName(required): string
  Title: VariableName

  Segment variable name.

{
    "type":"object",
    "required":[
        "variableName"
    ],
    "properties":{
        "title":{
            "type":"string",
            "description":"Segment label.",
            "title":"title"
        },
        "variableName":{
            "type":"string",
            "description":"Segment variable name.",
            "title":"VariableName"
        },
        "checked":{
            "type":"boolean",
            "description":"Is segment enabled.",
            "title":"Checked"
        },
        "icon":{
            "type":"string",
            "description":"Path of the icon image file. This field is only applicable if uiMetadata is set as true.",
            "title":"Icon"
        },
        "status":{
            "type":"integer",
            "description":"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":"Status"
        }
    },
    "title":"Sub Segment Details"
}

Nested Schema : items

Type: array

Show Source

• Array of: object User Details
  Title: User Details

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/groupUsers"
    }
}

Nested Schema : User Details

Type: object

Title: User Details

Show Source

• login(required): string
  Title: Login

  User login name.

{
    "type":"object",
    "required":[
        "login"
    ],
    "properties":{
        "login":{
            "type":"string",
            "description":"User login name.",
            "title":"Login"
        }
    },
    "title":"User Details"
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Group details.

Body ()

Root Schema : Group

Type: object

Title: Group

User group information

Show Source

• label: string
  Title: Group Name

  Group name
• type: string
  Title: Group Type

  Type of the group
• variableName: string
  Title: Group Variable Name

  Variable name of the group

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Group name",
            "title":"Group Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name of the group",
            "title":"Group Variable Name"
        },
        "type":{
            "type":"string",
            "description":"Type of the group",
            "title":"Group Type"
        }
    },
    "title":"Group",
    "description":"User group information"
}

Back to Top

Examples

The following example creates a group for the host company or partner organization based on logged in users 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" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/companies/visionServices/groups

Request Body Sample

{
  "label": "Midwest Test Group",
  "variableName": "midwestTestGroup",
  "description": "Midwest Test Group",
  "type": {
    "value": 1,
    "displayValue": "Administrator"
  },
  "users": {
    "items": [{
        "login": "superuser"
      }, {
        "login": "jsanchez"
      }
    ]
  },
  "segments": {
    "items": [{
        "variableName": "_commerceAndDocuments",
        "checked": false,
        "segments": {
          "items": [{
              "variableName": "_processDefinition",
              "checked": true
            }, {
              "variableName": "_processInvocation",
              "checked": true
            }, {
              "variableName": "_commerceSettings",
              "checked": true
            }, {
              "variableName": "_documents",
              "checked": true
            }
          ]
        }
      }, {
        "variableName": "_developerTools",
        "segments": {
          "items": [{
              "variableName": "_dataTables",
              "checked": false,
              "segments": {
                "items": [{
                    "variableName": "_default",
                    "checked": true
                  }, {
                    "variableName": "aBOTables",
                    "checked": true
                  }
                ]
              }
            }
          ]
        }
      }, {
        "variableName": "_general",
        "checked": true
      }, {
        "variableName": "_products",
        "segments": {
          "items": [{
              "variableName": "_catalogDefinition",
              "segments": {
                "items": [{
                    "variableName": "integration",
                    "checked": false
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Response Body Sample

{
  "label": "Midwest Test Group",
  "variableName": "midwestTestGroup",
  "description": "Midwest Test Group",
  "company": {
    "name": "Vision Services",
    "login": "_host"
  },
  "status": {
    "value": 1,
    "displayValue": "Active"
  },
  "type": {
    "value": 1,
    "displayValue": "Administrator"
  },
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/companies/visionServices/groups/midwestTestGroup"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/companies/visionServices/groups/midwestTestGroup/segments"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/companies/visionServices/groups/midwestTestGroup/users"
    }
  ]
}

Back to Top