Get application-level configuration (modules, holidays, translations, quick-links)

GET /mywork/v1/app-config

Operation id: getAppConfig

Description

Returns one or more application configuration domains merged under app_config in one call. config_type selects which domains to include; omit it (or pass all) to receive all types. config_type matching is case-insensitive. Partially invalid comma-separated lists → E204.

Authentication: domainId, authToken, and langCode are always resolved from the validated session. These cannot be overridden by the client.

Valid Config Types

Response Structure by Config Type

modules → {module_arr[], module_seq, landing_page} Each module_arr[*] item: product_id, product_name, name, description, base_url, build_version, version, product_no, has_mobile_app, enable_user_view, do_cache_module, mobile_app_store_url, mobile_app_play_store_url, mobile_app_url_scheme, logout_url.

module_list → Array of {domain_id, module_id, module_name}.

modules_menu → Array of menu objects. Each item: menu_id, display_label, module_id, page_id, seq_no, function_id, relative_web_url, web_url, icon_url, relative_icon_url, expose_as_how_do_i (Boolean), preferred (Boolean), sub_menus[] (recursive — same structure).

module_service → Single menu item object matching menu_id within the module hierarchy. Same fields as modules_menu items. Nested under {status, response: {...}}.

holidays → {holidays[], restricted_days[]}. Each item: date (MM/dd/yyyy), reason (String).

translations → Flat key-value map of resource bundle IDs to translated strings, e.g. {"10000001": "Dashboard", "10000002": "Settings"}. Empty object {} when none.

quick_links → {emp_help_configs[], module_configs[]}. Each emp_help_configs[*]: config_id, product_id, module_id, message_text (URL-encoded), action_type, how_flag, profile_id, seq_no, mobility_handler, user_config (present for EXTERNAL links). Each module_configs[*]: same shape as modules_menu item.

Error Scenarios

Error Codes Reference

Tags: MyWorkAppConfig

Parameters

Query parameters

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 — {status: OK, app_config: {...}}.

The app_config object contains only the keys matching the requested config_type. When config_type=all or omitted, all seven type keys are present.

Content type: application/json

400 — E204 — Invalid app config type.

E130 — module_id required for modules_menu/module_service. E131 — menu_id required for module_service. E132 — start_date and end_date required for holidays.

Content type: application/json

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — Success — {status: OK, app_config: {...}}.

The app_config object contains only the keys matching the requested config_type. When config_type=all or omitted, all seven type keys are present.

Content type: application/json

Schema

JSON object (structure varies by endpoint).

{
  "type": "object",
  "description": "JSON object (structure varies by endpoint)."
}

Example:

{
  "status": "OK",
  "app_config": {
    "modules": {
      "module_arr": [
        {
          "product_id": "RSP",
          "product_name": "Incoming",
          "name": "Incoming",
          "base_url": "https://fs3.reflexisinc.com/MYWORK",
          "build_version": "17.0.R6_6",
          "has_mobile_app": "false",
          "enable_user_view": "Y",
          "do_cache_module": "true"
        }
      ],
      "module_seq": "RSP,RTM20,MWSWA",
      "landing_page": {
        "default_menu_id": "FEED"
      }
    },
    "module_list": [
      {
        "domain_id": 170010099,
        "module_id": "RSP",
        "module_name": "Incoming"
      }
    ],
    "holidays": {
      "holidays": [
        {
          "date": "07/04/2026",
          "reason": "Independence Day"
        }
      ],
      "restricted_days": []
    }
  }
}

400 — E204 — Invalid app config type.

E130 — module_id required for modules_menu/module_service. E131 — menu_id required for module_service. E132 — start_date and end_date required for holidays.

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "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. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E204",
  "response": "Invalid app config type. Valid values: modules, module_list, modules_menu, module_service, holidays, translations, quick_links"
}

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "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. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E202",
  "response": "User session is invalid"
}

500 — Unexpected server-side error

Content type: application/json

Schema

{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "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. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}