REST API Services for Oracle CPQ

Get Sales Users

get

/rest/v16/salesUsers

Use this endpoint to retrieve a list of all sales users.

Request

Supported Media Types

application/json

Query Parameters

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.

Response

Supported Media Types

application/json

Default Response

Root Schema : salesUsers-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/salesUsers"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: array The list of sales user keys

Title: The list of sales user keys

The list of sales users to whom the trsacations are forwarded to

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

Nested Schema : The list of sales user keys

Type: array

Title: The list of sales user keys

The list of sales users to whom the trsacations are forwarded to

Show Source

Array of: string

{
    "title":"The list of sales user keys",
    "type":"array",
    "description":"The list of sales users to whom the trsacations are forwarded to",
    "items":{
        "type":"string"
    }
}

Examples

The following example shows how to retrieve a list of sales users 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/salesUsers

Response Body Sample

{
  "items": [{
      "firstName": "Automation_UserType_RestrictedAccess",
      "lastName": null,
      "dateModified": "2021-09-17T00:22:17.000Z",
      "key": "restuser1",
      "dateAdded": "2008-05-05T03:29:53.000Z",
      "email": "firstname.lastname@yourcompany.com",
      "links": [{
          "rel": "self",
          "href": "https://localhost:8080/rest/v16/salesUsers/4131038"
        }
      ]
    }, {
      "firstName": "Super",
      "lastName": "User",
      "dateModified": "2021-10-11T18:20:13.000Z",
      "key": "user1234",
      "dateAdded": "2004-07-07T04:06:31.000Z",
      "email": "john.jones@yourcompany.com",
      "links": [{
          "rel": "self",
          "href": "https://localhost:8080/rest/v16/salesUsers/4119220"
        }
      ]
    }
}