Jump to

• Request
• Response
• Examples

Get Sales Groups

get

/rest/v19/salesGroups

Use this endpoint to retrieve a list of all sales groups available to a user. User are only able to view Sales Groups that are part of their same organization (partner organization or host company).

Request

Supported Media Types

• application/json

Query Parameters

• expand: string
  Allows expansion of relationships.
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• 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 pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. 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

Body ()

Root Schema : salesGroups-collection

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/salesGroups"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Sales Groups
  Title: Sales Groups

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

Nested Schema : Sales Groups

Type: object

Title: Sales Groups

Show Source

• label: string
  Title: Group Label

  Label of the group.
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  The identifier for a sales group.
• variableName: string
  Title: Group Variable Name

  Variable Name of the group.

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"The identifier for a sales group.",
            "title":"Id"
        },
        " label":{
            "type":"string",
            "description":"Label of the group.",
            "title":"Group Label"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the group.",
            "title":"Group Variable Name"
        }
    },
    "title":"Sales Groups"
}

Back to Top

Examples

The following example shows how to retrieve a list of sales groups by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/salesGroups

Response Body Sample

{
  "items": [{
      "variableName": "technicalGroup",
      "dateModified": "2013-12-20T22:32:15.000Z",
      "id": 5671402,
      "label": "No Longer Used 21",
      "dateAdded": "2008-05-14T12:45:17.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/salesGroups/5671402"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v19/salesGroups/5671402/translations"
        }
      ]
    }, {
      "variableName": "a100kAccounts",
      "dateModified": "2020-05-18T21:41:13.000Z",
      "id": 9898200,
      "label": "100k Accounts",
      "dateAdded": "2011-01-18T06:06:27.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/salesGroups/9898200"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v19/salesGroups/9898200/translations"
        }
      ]
    }
  ]
}

Back to Top