Get matching tags for autocomplete
GET /mywork/v1/tags/{module-id}/{matchtext}
Operation id: getMatchingTags
Description
Returns tags matching the partial text in {matchtext} for the given {module-id}.
Unified replacement for legacy:
POST /service/tags/similarTags— whenservice_tokenis providedPOST /service/tags/fetchAllMatchingTags— whenservice_tokenis omitted or blank
Routing (service_token as mode selector):
service_token | Backend |
|---|---|
| Provided (non-blank) | Service Router (similarApplicationTags) — requires SMART_SEARCH permission |
| Omitted or blank | Direct Mongo (MW_SYSTEM_TAGS via fetchMyWorkMatchingTags) |
Session-sourced: domain_id is resolved from X-reflexis-csrf-token-X; not accepted as a parameter.
Path encoding: {matchtext} must be URL-encoded when it contains spaces or special characters.
See devdocs/api/nextgen/mywork/MYWORK_API_CONTRACT_Tags.md for full contract.
Tags: MyWorkTags
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
matchtext | string | Yes | Partial tag text to match (URL-encode special characters) |
module-id | string | Yes | Module identifier (e.g. MYWORK) |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
service_token | string | No | Service Router token (domain-configured). When provided, routes via Service Router. When omitted, reads directly from Mongo. Examples: myworkTags, getMyWorkSimilarTags, qCheckTags, qDocsTags. |
Security
- ApiKeyHeader (apiKey)
- APIGEE API key header validated by VerifyAPIKey policy.
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store.
Responses
200 — Success — matching tags (may be empty array)
Content type: application/json
401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)
Content type: application/json
403 — E371 — SMART_SEARCH permission required when service_token is provided
Content type: application/json
500 — E356 — unable to retrieve matching tags
Content type: application/json
Response models
200 — Success — matching tags (may be empty array)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | |
tags | array | Yes |
{
"type": "object",
"required": [
"status",
"tags"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Example:
{
"status": "OK",
"tags": [
"Sale Item",
"Sale Promo"
]
}
401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
}
403 — E371 — SMART_SEARCH permission required when service_token is provided
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E371",
"response": "User does not have SMART_SEARCH permission"
}
500 — E356 — unable to retrieve matching tags
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E302) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E302)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E356",
"response": "Unable to retrieve matching tags"
}