Run a saved advanced search query

Run a saved advanced search query

Path Parameters

• id uuid required

  ID of the object to retrieve or update

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e

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

Responses

• 200

---

Expected response to a valid request

application/json

• Schema
• Example (from schema)

---

Schema

• profiles object[]

  id uuid

  the id

  uid string

  Possible values: >= 32 characters and <= 32 characters

  the uid

  name string

  the name

  profile_type_id uuid

  The profile type id

  status string

  Possible values: [Active, Inactive, On Leave, Terminated]

  the status

  id_proofing_status string

  Possible values: [pending, pass, fail]

  the id profing status

  created_at date-time

  the created at time

  updated_at date-time

  the 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"
      }
    }
  ]
}

Loading...