Universal Search

POST /internal/admin/comms/v1/u-search

Operation id: post__internal_admin_comms_v1_u_search

Description

Perform a universal search across communication services (scopes 1, 2, 4, 5, and 6) and Todo services (3, 7, 8, and 9).

Scope values:

• 1 = Broadcast
• 2 = Messages
• 3 = Tasks
• 4 = Attachments
• 5 = Forums
• 6 = Contacts
• 7 = TaskTags
• 8 = TasksForYou
• 9 = TasksAll

Tags: U-Search

Security

• BearerAuth (http / bearer)
  • Enter the token

Responses

200 — Scope-wise search results

Content type: application/json

400 — Bad request (validation errors)

Content type: application/json

401 — Unauthorized

Content type: application/json

502 — Upstream service failure

Content type: application/json

Request body

Required: Yes

application/json

Schema

{
  "type": "object",
  "required": [
    "filter",
    "scope"
  ],
  "properties": {
    "filter": {
      "type": "string",
      "description": "Search query string (non-empty)"
    },
    "scope": {
      "type": "array",
      "description": "Array of search scope identifiers",
      "items": {
        "type": "integer",
        "description": "Scope (name -> value):\n  Broadcast        = 1\n  ChatFeeds        = 2\n  Tasks            = 3\n  Attachments      = 4\n  Forums           = 5\n  Contacts         = 6\n  TaskTags         = 7\n  TasksForYou      = 8\n  TasksAll         = 9\n",
        "enum": [
          1,
          2,
          3,
          4,
          5,
          6,
          7,
          8,
          9
        ]
      }
    },
    "limit": {
      "type": "integer",
      "description": "Max results (default 3, max 50)"
    }
  }
}

Response models

200 — Scope-wise search results

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "description": "Array of scope-wise results",
      "items": {
        "type": "object",
        "properties": {
          "scope": {
            "type": "integer",
            "description": "Scope identifier"
          },
          "data": {
            "description": "Scope-specific data (structure varies by scope)"
          },
          "error": {
            "type": "string",
            "description": "Error message if this scope failed"
          }
        }
      }
    }
  }
}

400 — Bad request (validation errors)

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

401 — Unauthorized

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "example": 0
    },
    "message": {
      "type": "string",
      "example": "Success"
    }
  }
}

502 — Upstream service failure

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    }
  }
}