Run an advanced search for profiles, without saving the query

POST 
/advanced_search/run

Run an advanced search for profiles, without saving the query

Request

Query Parameters

query object

Allows for pagination and sorting.

application/json

Body

required

advanced_search object
label string
condition_rules_attributes object[]
Array [
anyOf
ProfileTypeRule-2
type string
Possible values: [ProfileTypeRule]
comparison_operator string
Possible values: [==, !=]
value uuid
ProfileStatusRule-2
type string
Possible values: [ProfileStatusRule]
comparison_operator string
Possible values: [==, !=]
value string
Possible values: [Active, Inactive, Leave of absence, Terminated]
ProfileAttributeRuleString-2
type string
Possible values: [ProfileAttributeRule]
condition_object_type string
Possible values: [TextFieldAttribute, TextAreaAttribute]
condition_object_id uuid
comparison_operator string
Possible values: [==, !=, >, <, start_with?, end_with?, include?]
value string
ProfileAttributeRuleDate-2
type string
Possible values: [ProfileAttributeRule]
condition_object_type string
Possible values: [DateAttribute]
condition_object_id uuid
secondary_attribute_type string
Possible values: [DateAttribute]
secondary_attribute_id uuid
comparison_operator string
Possible values: [>, <, after, before]
value string
Possible values: [Today, <uid>]
secondary_value string
Possible values: [after, before]
tertiary_value string
ProfileAttributeRuleId-2
type string
Possible values: [ProfileAttributeRule]
condition_object_type string
Possible values: [ProfileSelectAttribute, ProfileSearchAttribute, OwnerSelectAttribute, OwnerSearchAttribute, ContributorSelectAttribute, ContributorSearchAttribute]
condition_object_id uuid
comparison_operator string
Possible values: [include?, exclude?]
value uuid
RiskRule-2
type string
Possible values: [RiskRule]
comparison_operator string
Possible values: [==, >, <]
value uuid
secondary_value string
Possible values: [OverallRisk]
]

Responses

200

Expected response to a valid request

application/json

Schema

Schema

profiles object[]
Array [
id uuid
The objects ID
uid string
Possible values: >= 32 characters and <= 32 characters
The objects UID
name string
This is the name of the profile.
profile_type_id uuid
This is the ID of the profile type the profile belongs to
status string
Possible values: [Active, Inactive, On Leave, Terminated]
This is the status of the profile
id_proofing_status string
Possible values: [pending, pass, fail]
This is the ID proofing staus of the profile
created_at date-time
The date and time the profile was created
updated_at date-time
The date and time the profile was updated
attributes object
Attributes that belong to this profile.
property name* string
]

Example (from schema)

{
  "profiles": [
    {
      "id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
      "uid": "profileUid",
      "name": "Profile Name",
      "profile_type_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
      "status": "Active",
      "id_proofing_status": "pending",
      "created_at": "2023-11-21T14:23:54.256-05:00",
      "updated_at": "2023-11-21T14:23:54.256-05:00",
      "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"
      }
    }
  ]
}

Loading...