Run an advanced search for profiles, without saving the query​
Run an advanced search for profiles, without saving the query
Query Parameters
- query object
Allows for pagination and sorting using the deepObject notation.
resource?query[limit]=50&query[offset]=0&query[order]=label
Parameter Description Default limit Limits the number of results returned 100 offset Returns the results starting at the value provided 0 order Allows you to determine the order in which the data is returned (not available on profile attributes) id Example: query[limit]=100&query[offset]=50&query[order]=created_at
- application/json
Request Body required
advanced_search object
label stringthe label
condition_rules_attributes object[]
The condition rules attributes
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
type stringPossible values: [
ProfileTypeRule
]The type
comparison_operator stringPossible values: [
==
,!=
]The operator to use for comparison
value uuidThe value
type stringPossible values: [
ProfileStatusRule
]the type
comparison_operator stringPossible values: [
==
,!=
]The operator to use for comparison
value stringPossible values: [
Active
,Inactive
,Leave of absence
,Terminated
]The value
type stringPossible values: [
ProfileAttributeRule
]The type
condition_object_type stringPossible values: [
TextFieldAttribute
,TextAreaAttribute
]The condition_object_type
condition_object_id uuidThe condition_object_id
comparison_operator stringPossible values: [
==
,!=
,>
,<
,start_with?
,end_with?
,include?
]the operator to use for comparison
value stringthe value to use for comparison
type stringPossible values: [
ProfileAttributeRule
]The type
condition_object_type stringPossible values: [
DateAttribute
]The condition_object_type
condition_object_id uuidThe condition_object_id
secondary_attribute_type stringPossible values: [
DateAttribute
]The secondary_attribute_type
secondary_attribute_id uuidThe secondary_attribute_id
comparison_operator stringPossible values: [
>
,<
,after
,before
]The operator to use when comparing
value stringPossible values: [
Today
,<uid>
]The value
secondary_value stringPossible values: [
after
,before
]The secondary_value
tertiary_value stringThe tertiary_value
type stringPossible values: [
ProfileAttributeRule
]The type
condition_object_type stringPossible values: [
ProfileSelectAttribute
,ProfileSearchAttribute
,OwnerSelectAttribute
,OwnerSearchAttribute
,ContributorSelectAttribute
,ContributorSearchAttribute
]The conditon object type
condition_object_id uuidThe condition object id
comparison_operator stringPossible values: [
include?
,exclude?
]The operator to use for comparison
value uuidThe value
type stringPossible values: [
RiskRule
]The type
comparison_operator stringPossible values: [
==
,>
,<
]The operator to use for comparison
value uuidThe value to use
secondary_value stringPossible values: [
OverallRisk
]The secondary value to use
- 200
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
profiles object[]
id uuidthe id
uid stringPossible values:
>= 32 characters
and<= 32 characters
the uid
name stringthe name
profile_type_id uuidThe profile type id
status stringPossible values: [
Active
,Inactive
,On Leave
,Terminated
]the status
id_proofing_status stringPossible values: [
pending
,pass
,fail
]the id profing status
created_at date-timethe created at time
updated_at date-timethe updated at time
attributes object
the attributes
property name*
string
{
"profiles": [
{
"id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"name": "my profile",
"profile_type_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"status": "Active",
"id_proofing_status": "pending",
"created_at": "2023-05-01T09:12:28Z",
"updated_at": "2023-05-01T09:12:28Z",
"attributes": {
"text_attribute_uid": "static text",
"date_attribute_uid": "01/15/2020",
"profile_select_attribute_uid": "Profile Name",
"multiple_profile_select_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
"contributor_select_attribute_uid": "User Name",
"multiple_contributor_select_attribute_uid": "User Name,Second User Name,Third User Name"
}
}
]
}