Jump to

• Request
• Response
• Examples

Get Sales Company

get

/rest/v16/salesCompanies/{companyLogin}

Use this endpoint to retrieve 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 response for getting a single sales company.

Body ()

Root Schema : salesCompanyItem

Type: object

Show Source

• links: array links
• login: string
  Example: companyOne
• name: string
  Example: companyOne

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"companyOne"
        },
        "login":{
            "type":"string",
            "example":"companyOne"
        },
        "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

The user has no access to the resource

404 Response

Search with id not be found

Back to Top

Examples

The following example shows how to retrieve the specified company login name 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

Response Body Sample

{
  "name": "A1BM1",
  "login": "a_Co1BM",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/groups",
      "name": "groups"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users",
      "name": "users"
    }
  ]
}

Back to Top