Get merged MyWork configuration for requested types

GET /task/v1/config/list

Operation id: getMyWorkConfigList

Description

Returns one or more MyWork configuration domains merged into a flat config_list object. Fields from all requested types appear at the same level under config_list. When multiple types are requested via comma-separation, fields are merged in enum declaration order: calendar → feed → attachment → smart_search → refresh → filter → feed_component → action_box.

Authentication: domainId and langCode are always resolved from the validated session.


Valid Config Types

ValueDescriptionResponse Fields
calendarCalendar/Gantt view settingsdefault_calendar_view, gantt_date_span, calendar_setup[], show_all_days
feedFeed display and metadatafeed_status_data[], feed_date_span, sort_order[], priority_data, overdue_date_span, allow_bulk_action, show_notes_in_web_view, allow_notes_in_webview, no_records, proj_status_css, fyi_config[], feed_uiconfig, project_type_data[], message_type_data[]
attachmentUpload constraintsmax_upload_size, allowed_attachments, comment_max_attach_count, button_max_attach_count
smart_searchSmart-search filter configsm_filter (absent if user lacks RSP smart_search permission)
refreshAuto-refresh intervals (ms)feed_refresh_rate, msg_refresh_rate
filterFilter panel settingsmax_filter_name_characters, filter_date_range, max_feed_notes_characters, list_task_limit
feed_componentDB-driven feed UI componentsfeed_config_details[] (empty array when none configured)
action_boxAction Box shortcut parent buttonssupported_actions[] (empty array when none configured)
allAll types merged (default)All fields from every type above

Response Fields Reference

calendar fields

FieldTypeDescription
default_calendar_viewStringDefault view code; empty string if not configured
gantt_date_spanStringNumber of days shown in Gantt date range
calendar_setup[]ArrayOrdered list of calendar sources. Each: key, value, on_click, view, default{layout,view}
show_all_daysString/null"Y" when all calendar days are shown; absent/null otherwise

feed fields

FieldTypeDescription
feed_status_data[]ArrayOrdered list of feed statuses. Each: display_text, status (uppercase code — P, R, C, E, F, N, O)
feed_date_spanStringDefault date span in days for feed list queries
sort_order[]ArraySort options: each has key, description, type (numeric/character/miscellaneous), value (A/D)
priority_dataObjectMap of priority number → {priority_desc, color, img or img_path}
overdue_date_spanIntegerDays past due before considered overdue
allow_bulk_actionString"Y" if bulk actions enabled
show_notes_in_web_viewString"Y" to show feed notes in web view; "N" otherwise (default)
allow_notes_in_webviewString"Y" to allow feed notes in web view; "N" otherwise (default)
no_recordsStringDefault page size for feed list
proj_status_cssObject{ config: { <STATUS_CODE>: <css_string> } }. Inner status codes (e.g. C, E, O) are preserved in their canonical uppercase form
fyi_config[]ArrayCSS config objects for FYI message rendering
feed_uiconfigObjectUI feature flags: show_efforts, msg_content_expanded, show_inactive_tasks, due_by_css, display_date, show_due_by, display_day_start_time
project_type_data[]ArrayOrdered list of project types. Each: key (project type code, e.g. SP), name (display label), icon_url (absolute icon URL)
message_type_data[]ArrayOrdered list of message types. Each: key (message type code), description (display label), icon_url (absolute icon URL)

attachment fields

FieldTypeDescription
allowed_attachmentsStringComma-separated permitted file extensions
max_upload_sizeIntegerMax upload size in bytes (e.g. 1048576 = 1 MB)
comment_max_attach_countIntegerMax attachments per comment
button_max_attach_countIntegerMax attachments per button action

refresh fields

FieldTypeDescription
feed_refresh_rateIntegerFeed auto-refresh polling interval in milliseconds
msg_refresh_rateIntegerMessaging auto-refresh polling interval in milliseconds

filter fields

FieldTypeDescription
max_filter_name_charactersStringMax character length for a saved filter name
filter_date_rangeIntegerDefault date range in days for filter date pickers
max_feed_notes_charactersStringMax character length for feed notes
list_task_limitIntegerMax tasks shown in list view before pagination

feed_component fields

FieldTypeDescription
feed_config_details[]ArrayDB-driven feed UI component overrides. Empty [] when none. Each item: component_id, new_image, css_content, actual_image, show_flag

action_box fields

FieldTypeDescription
supported_actions[]ArrayAction Box flow shortcut entries from ACTION_BOX_SETUP / SUPPORTED_ACTIONS. Empty [] when none. Each item: name, id (STATUS_BUTTON, REASSIGN_BUTTON, OTHER_BUTTON), seq_id (display order), button_ids[] (configured root parent button ids). Map id to /action-box/flow flags: STATUS_BUTTON → is_update_status, REASSIGN_BUTTON → is_reassign, OTHER_BUTTON → is_other_button.

Error Scenarios

ScenarioHTTPError CodeMessage
Missing X-reflexis-csrf-token-X header400E112X-reflexis-csrf-token-X header is mandatory
Invalid or expired token401E204Invalid or expired token
Unknown or empty config_type token400E203Invalid config type. Valid values: calendar, feed, ...
Unexpected server-side error500E302Internal server error

Error Codes Reference

CodeDescription
E112X-reflexis-csrf-token-X header is mandatory
E204Invalid or expired token
E203Invalid config type
E302Internal server error

Tags: MyWorkConfig

Parameters

Query parameters

NameTypeRequiredDescription
config_typestringNoDefault: ALL (returned when parameter is omitted or set to all). Case-insensitive. Accepted values (single, comma-separated, or all): CALENDAR, FEED, ATTACHMENT, SMART_SEARCH, REFRESH, FILTER, FEED_COMPONENT, ACTION_BOX, ALL. Any unrecognised token → HTTP 400 E203. Example: ?config_type=CALENDAR,FEED returns only calendar and feed fields.

Security

  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store.

Responses

200 — Success — {status: OK, config_list: {...}}. All requested type fields

appear flat under config_list. When config_type=ALL or omitted, all 8 type field sets are merged together.

Content type: application/json

400 — E203 — Invalid config type. Returned when config_type contains an unrecognised token.

Content type: application/json

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — Success — {status: OK, config_list: {...}}. All requested type fields

appear flat under config_list. When config_type=ALL or omitted, all 8 type field sets are merged together.

Content type: application/json

Schema

JSON object (structure varies by endpoint).

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

Example:

{
  "status": "OK",
  "config_list": {
    "default_calendar_view": "",
    "gantt_date_span": "10",
    "calendar_setup": [
      {
        "key": "CALENDAR",
        "value": "My Projects",
        "on_click": "FV",
        "view": "A",
        "default": {
          "layout": "M",
          "view": "P"
        }
      }
    ],
    "feed_status_data": [
      {
        "display_text": "In Progress",
        "status": "P"
      },
      {
        "display_text": "Reviewed",
        "status": "R"
      },
      {
        "display_text": "Completed",
        "status": "C"
      },
      {
        "display_text": "Expired",
        "status": "E"
      },
      {
        "display_text": "Force Closed",
        "status": "F"
      },
      {
        "display_text": "New",
        "status": "N"
      },
      {
        "display_text": "Overdue",
        "status": "O"
      }
    ],
    "feed_date_span": "15",
    "no_records": "20",
    "overdue_date_span": 6,
    "allow_bulk_action": "Y",
    "show_notes_in_web_view": "N",
    "allow_notes_in_webview": "N",
    "allowed_attachments": "png,gif,jpg,jpeg,pdf,docx,pptx,xlsx,csv,txt,zip,mp4",
    "max_upload_size": 1048576,
    "comment_max_attach_count": 5,
    "button_max_attach_count": 3,
    "feed_refresh_rate": 15000,
    "msg_refresh_rate": 60000,
    "filter_date_range": 31,
    "max_feed_notes_characters": "8000",
    "max_filter_name_characters": "255",
    "list_task_limit": 5,
    "feed_config_details": [],
    "supported_actions": [
      {
        "name": "Status Action",
        "id": "STATUS_BUTTON",
        "seq_id": 1,
        "button_ids": [
          "1-PROJECTEXTRACT1",
          "14-PROJECTEXTRACT1",
          "14-PROJECTEXTRACT11",
          "24-PROJECTEXTRACT1",
          "24-PROJECTEXTRACT11",
          "33-PROJECTEXTRACT1",
          "33-PROJECTEXTRACT11",
          "44-PROJECTEXTRACT1",
          "44-PROJECTEXTRACT11",
          "45-PROJECTEXTRACT1",
          "45-PROJECTEXTRACT11",
          "8-PROJECTEXTRACT1",
          "8-PROJECTEXTRACT11"
        ]
      },
      {
        "name": "Reassign Action",
        "id": "REASSIGN_BUTTON",
        "seq_id": 2,
        "button_ids": [
          "1-PROJECTEXTRACT2",
          "33-PROJECTEXTRACT12",
          "44-PROJECTEXTRACT2",
          "9-PROJECTEXTRACT1",
          "9-PROJECTEXTRACT11"
        ]
      },
      {
        "name": "Other supported buttons",
        "id": "OTHER_BUTTON",
        "seq_id": 3,
        "button_ids": [
          "1-PROJECTEXTRACT7"
        ]
      }
    ]
  }
}

400 — E203 — Invalid config type. Returned when config_type contains an unrecognised token.

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": "E203",
  "response": "Invalid config type. Valid values: calendar, feed, attachment, smart_search, refresh, filter, feed_component, action_box, all, or comma-separated combination"
}

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

500 — Unexpected server-side error

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": "E302",
  "response": "Internal server error"
}