Skip to main content
Version: 1.1beta2

clarify.selectItems

Require access to Clarify namespace

For an integration to access this method, it must have been granted access to the Clarify namespace.

A resource select method for the items resource.

Method parameters

ParameterPropertiesDescription
query
Resource query
default={}Resource query to select items.
include
array(string(enum))
default=[]Relationships to include. Allow inclusion of "item".
groupIncludedByType
bool
default=falseAlter result format to group included resources by type.

Result

The result contains a JSON:API compatible resource selection result if groupIncludedByType was set to false.

type: object

FieldDescription
meta
Selection meta
Selection meta data.
data
array(Item select)
Resource selection.
included
array(resource),map(string => array(resource))
Side-loaded resources from relationships.

Rates and limits

Query:

  • query.limit:
    • default is 20.
    • maximum is 1000.

API access:

  • The API is rate-limited to 10 request/sec.

Example

The curl example uses Basic Auth for simplicity.

# BASIC_AUTH_USERNAME=<Username from Basic Auth credentials>
# BASIC_AUTH_PASSWORD=<Password from Basic Auth credentials>
# INTEGRATION_ID=${BASIC_AUTH_USERNAME}
curl -u ${BASIC_AUTH_USERNAME}:${BASIC_AUTH_PASSWORD} \
--request POST \
--url 'https://api.clarify.io/v1/rpc' \
--header 'content-type: application/json' \
--header 'X-API-Version: 1.1beta2' \
--data \
'
{
"jsonrpc": "2.0",
"method": "clarify.selectItems",
"id": 10,
"params": {
"integration": "'${INTEGRATION_ID}'",
"query": {
"filter": {
"annotations.docs-clarify-io/example/name": "publish_signals"
},
"limit": 10
}
}
}
'