Jump to

• Request
• Response
• Examples

Get Groups for the Host Company or for a Partner Organization

get

/rest/v16/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
  Title: Group

  User group information

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

Nested 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 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 -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/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/v16/companies/_host/groups/general"
        },
        {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/companies/_host/groups/iragroup"
        },
        {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/groups/iragroup/users"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 2,
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/groups"
    },
    {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/groups?offset=0&limit=1000"
    }
  ]
}

Back to Top