Jump to

• Request
• Response
• Examples

Get Sales Company Group

get

/rest/v16/salesCompanies/{companyLogin}/groups/{groupVarName}

Use this endpoint to retrieve the specified sales company group.

Request

Path Parameters

• companyLogin(required): string
  The unique variable name to identify the company
• groupVarName(required): string
  The unique variable name for the sales group

Back to Top

Response

200 Response

The sales group for the company retrieved successfully

Body ()

Root 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
• 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"
}

403 Response

User has no access to the company resource

404 Response

The company resource or the group not found

Back to Top

Examples

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

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/groups/aGroup1

Response Body Sample

{
  "label": "AGroup1",
  "variableName": "aGroup1",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/groups/aGroup1"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/groups"
    }
  ]
}

Back to Top