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 — when service_token is provided
  • POST /service/tags/fetchAllMatchingTags — when service_token is omitted or blank

Routing (service_token as mode selector):

service_tokenBackend
Provided (non-blank)Service Router (similarApplicationTags) — requires SMART_SEARCH permission
Omitted or blankDirect 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

NameTypeRequiredDescription
matchtextstringYesPartial tag text to match (URL-encode special characters)
module-idstringYesModule identifier (e.g. MYWORK)

Query parameters

NameTypeRequiredDescription
service_tokenstringNoService Router token (domain-configured). When provided, routes via Service Router. When omitted, reads directly from Mongo. Examples: myworkTags, getMyWorkSimilarTags, qCheckTags, qDocsTags.

Security

  • 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

PropertyTypeRequiredDescription
statusstringYes
tagsarrayYes
{
  "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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-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"
}