Jump to

• Request
• Response
• Examples

Get Groups for the Host Company or for a Partner Organization

get

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

This endpoint retreives a list of groups for the host company or for a partner organization.

Request

Path Parameters

• companyLoginName(required): string
  Company login name.

Query Parameters

• excludeLinks: string
  Exclude given link types from response. Supported only with produces type application/json.

  Allowed Values: [ "self", "child", "parent", "canonical", "next", "prev", "related" ]
• expand: string
  Allows expansion of relationships.

  Allowed Values: [ "users" ]
• fields: string
  Group fields to be returned in response.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of fields to order the response by.
• q: string
  Criteria to filter the groups. By default no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

List of groups.

Body ()

Root Schema : group-collection

Type: object

Show Source

• items: array List of Groups
  Title: List of Groups

  List of groups.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of groups.",
            "title":"List of Groups",
            "items":{
                "$ref":"#/definitions/group"
            }
        }
    }
}

Nested Schema : List of Groups

Type: array

Title: List of Groups

List of groups.

Show Source

• Array of: object Group Details
  Title: Group Details

{
    "type":"array",
    "description":"List of groups.",
    "title":"List of Groups",
    "items":{
        "$ref":"#/definitions/group"
    }
}

Nested Schema : Group Details

Type: object

Title: Group Details

Show Source

• company: object Company Details
  Title: Company Details

  Company details to which the group belongs.
• description: string
  Title: Description

  Description of the group.
• label: string
  Title: Label

  Label of the group.
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• readOnly: boolean
  Title: ReadOnly

  Is read only group?
• segments: object Segments
  Title: Segments

  Access Segments for a group
• status: object Status
  Title: Status

  Status of the group.
• type: object Type
  Title: Type

  Type of the group.
• users: object Users
  Title: Users

  All users of a group
• variableName: string
  Title: VariableName

  Group variable name.

{
    "type":"object",
    "properties":{
        "readOnly":{
            "type":"boolean",
            "description":"Is read only group?",
            "title":"ReadOnly"
        },
        "label":{
            "type":"string",
            "description":"Label of the group.",
            "title":"Label"
        },
        "variableName":{
            "type":"string",
            "description":"Group variable name.",
            "title":"VariableName"
        },
        "description":{
            "type":"string",
            "description":"Description of the group.",
            "title":"Description"
        },
        "status":{
            "type":"object",
            "description":"Status of the group.",
            "title":"Status",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "type":{
            "type":"object",
            "description":"Type of the group.",
            "title":"Type",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        },
        "company":{
            "$ref":"#/definitions/group-company-props"
        },
        "users":{
            "$ref":"#/definitions/user-collection"
        },
        "segments":{
            "$ref":"#/definitions/accessSegments-collection"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Group Details"
}

Nested Schema : Company Details

Type: object

Title: Company Details

Company details to which the group belongs.

Show Source

• loginName: string
  Title: Company Login Name

  Company login name.
• name: string
  Title: Company Name

  Company name.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Company name.",
            "title":"Company Name"
        },
        "loginName":{
            "type":"string",
            "description":"Company login name.",
            "title":"Company Login Name"
        }
    },
    "title":"Company Details",
    "description":"Company details to which the group belongs."
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Segments

Type: object

Title: Segments

Access Segments for a group

Show Source

• items: array items
• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/accessSegments"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Segments",
    "description":"Access Segments for a group"
}

Nested Schema : Status

Type: object

Title: Status

Status of the group.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Status of the group.",
    "title":"Status",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Nested Schema : Type

Type: object

Title: Type

Type of the group.

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

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

Nested Schema : Users

Type: object

Title: Users

All users of a group

Show Source

• items: array items
• links: array Links
  Title: Links

  Links to the related objects.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/user"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Users",
    "description":"All users of a group"
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• name: string
• rel: string
  Title: Link Relationship to the current object

  Default Value: self

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Segment Details
  Title: Segment Details

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

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

Links to the related objects

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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

  User details of group.

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

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : User Details

Type: object

Title: User Details

User details of group.

Show Source

• firstName: string
  Title: User First Name

  First name of the user.
• lastName: string
  Title: User Last Name

  Last name of the user.
• login: string
  Title: User Login Id

  Login Id of the user.

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user.",
            "title":"User Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "title":"User First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "title":"User Last Name"
        }
    },
    "title":"User Details",
    "description":"User details of group."
}

Back to Top

Examples

The following example retrieves a list of groups for the host company or for a partner organization by submitting a GET 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 

Response Body Sample

{
  "items": [
    {
      "label": "General",
      "variableName": "general",
      "company": {
        "name": "visionServices",
        "loginName": "_host"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "type": {
        "value": 1,
        "displayValue": "Administrator"
      },
      "readOnly": false,
      "links": [
        {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/general"
        },
        {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/general/users"
        }
      ]
    },
    {
      "label": "No Longer Used 15",
      "variableName": "iragroup",
      "company": {
        "name": "visionServices",
        "loginName": "_host"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "type": {
        "value": 0,
        "displayValue": "Sales"
      },
      "readOnly": false,
      "links": [
        {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/iragroup"
        },
        {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/iragroup/users"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 2,
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/groups"
    },
    {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/groups?offset=0&limit=1000"
    }
  ]
}

Back to Top