Search accounts

  • 1 minute(s) read
Prev Next
Post
/accounts/search

Search for accounts and return a list of matching records.

Security
HTTP
Type bearer

OAuth access token. For details, read Obtain or refresh an OAuth token.

Body parameters

Example request payload as a resource.

Expand All
object
Example{ "elements": { "bda": [ "objectName" ], "bra": [ "includesAddress", "definesPartnerFunctionRecord", "definesSalesInfo" ] }, "filter": "objectName contains 'Test 1'", "include": [ "includesAddress", "definesPartnerFunctionRecord", "definesSalesInfo" ], "limit": 1 }
type
string

Retrieve the accounts in the system.

ExampleSearch
limit
integer

Defines the maximum number of records that can be returned.

Example1
offset
integer

Defines the number of records that should be skipped. Default value is 0.

Example0
filter
string

The filter parameter. If keyword contains space, it must be enclosed between two apostrophe('). If keyword is URI, it must be url encoded.

ExampleobjectName eq Account1
sort
Array of string

Defines the sorting of the result. 'ASC' for ascending and 'DESC' for descending order. Default order is objectName ASC.

string
ExampleobjectName DESC
elements
object

Sets the BDAs and BRAs that will be returned. id, type, uri , label and comment are included by default. If 'elements' is not specified, all the BDAs and BRAs will be returned.

bda
string

Defines the requested BDAs that will be returned. If set as empty string, only id, type, uri , label and comment will be returned.

Example[ "objectName", "objectId" ]
bra
string

Defines the requested BRAs that will be returned. If set as empty string, no BRAs will be returned. Ensure the BRA array contains all the dependent resources that are defined in 'include'.

Example[ "includesAddress" ]
revInclude
Array of string
string
Example
include
Array of string

Sets the related nested data that will be resolved.

string
ExampleincludesAddress
Responses
200

Returns the list of accounts as a bundle based on the example request payload.

{
  "type": "Bundle",
  "total": 1,
  "entry": [
    {
      "id": "aHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BY2NvdW50I2UxNGYxMjQ0ZTJlNzRiM2E5YzM4OTY3MDZiYjFlNWRi=-",
      "type": "Account",
      "uri": "http://localhost:8080/iss/Account#e14f1244e2e74b3a9c3896706bb1e5db",
      "objectName": "Account1",
      "objectId": "e14f1244e2e74b3a9c3896706bb1e5db",
      "includesAddress": [
        {
          "id": "aHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BZGRyZXNzIzU0MzQ5N2FiZDliNTQ2NzJiYTI4YzAxZmIyZmQyYTQ5",
          "type": "Address",
          "uri": "http://localhost:8080/iss/Address#543497abd9b54672ba28c01fb2fd2a49",
          "objectId": "543497abd9b54672ba28c01fb2fd2a49"
        }
      ]
    }
  ]
}
object
id
string (base64-encoded URI)
ExampleaHR0cDovL2xvY2FsaG9zdDo4MDgwL2lzcy9BY2NvdW50I2UxNGYxMjQ0ZTJlNzRiM2E5YzM4OTY3MDZiYjFlNWRi
uri
string
Examplehttp://localhost:8080/iss/Account#e14f1244e2e74b3a9c3896706bb1e5db
type
string
ExampleAccount
objectName
string
ExampleAccount1
objectId
string
Examplee14f1244e2e74b3a9c3896706bb1e5db