Jump to

• Request
• Response
• Examples

Get Sales Company Groups

get

/rest/v19/salesCompanies/{companyLogin}/groups

Use this endpoint to retrieve a list of groups for the specified company login name.

Request

Path Parameters

• companyLogin(required): string
  The unique variable name to identify the company

Back to Top

Response

200 Response

The sales groups for the company retrieved successfully

Body ()

Root Schema : SalesGroupCollectionModelResponse

Type: object

Show Source

• count: integer
• hasMore: boolean
  Default Value: false
• items: array items
• limit: integer
• links: array links
• offset: integer
• totalResutls: integer

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "totalResutls":{
            "type":"integer"
        },
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/salesGroupItem"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object salesGroupItem

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

Nested Schema : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

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

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

Nested Schema : salesGroupItem

Type: object

Show Source

• label: string
  Example: GroupOne
• links: array links
• variableName: string
  Example: groupOne

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "example":"GroupOne"
        },
        "variableName":{
            "type":"string",
            "example":"groupOne"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

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

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

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
• rel: string
  Title: Link Relationship to the current object

  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"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

403 Response

User has no access to the company resource

404 Response

The company resource not found

Back to Top

Examples

The following example shows how to retrieve a list of all sales company 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/salesCompanies/a_Co1BM/groups

Response Body Sample

{
  "items": [{
      "label": "AGroup1",
      "variableName": "aGroup1",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/salesCompanies/a_Co1BM/groups/aGroup1"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/salesCompanies/a_Co1BM/groups"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 1,
  "hasMore": false,
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/salesCompanies/a_Co1BM"
    }, {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/salesCompanies/a_Co1BM/groups"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/salesCompanies/a_Co1BM/groups?offset=0&limit=1000"
    }
  ]
}

Back to Top