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: calendarfeedattachmentsmart_searchrefreshfilterfeed_component.

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, 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)
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_dataObjectMap of status code → {display_text}. Keys: 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
no_recordsStringDefault page size for feed list
proj_status_cssObjectMap of project status code → CSS style string
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_dataObjectMap of project type code → display name
message_type_dataObjectMap of message type key → human-readable description

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

Error Scenarios

ScenarioHTTPError CodeMessage
Missing / invalid X-reflexis-csrf-token-X401E202User session is invalid
Unknown or empty config_type token400E203Invalid config type. Valid values: calendar, feed, ...
Unexpected server-side error500E302Internal server error

Error Codes Reference

CodeDescription
E202User session is invalid
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, ALL. Any unrecognised token → HTTP 400 E203. Example: ?config_type=CALENDAR,FEED returns only calendar and feed fields.

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, config_list: {...}}. All requested type fields

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

Content type: application/json

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

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, config_list: {...}}. All requested type fields

appear flat under config_list. When config_type=ALL or omitted, all 7 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": {
      "p": {
        "display_text": "In Progress"
      },
      "r": {
        "display_text": "Reviewed"
      },
      "c": {
        "display_text": "Completed"
      },
      "e": {
        "display_text": "Expired"
      },
      "f": {
        "display_text": "Force Closed"
      },
      "n": {
        "display_text": "New"
      },
      "o": {
        "display_text": "Overdue"
      }
    },
    "feed_date_span": "15",
    "no_records": "20",
    "overdue_date_span": 6,
    "allow_bulk_action": "Y",
    "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": []
  }
}

400E203 — 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. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "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": "E203",
  "response": "Invalid config type. Valid values: calendar, feed, attachment, smart_search, refresh, filter, feed_component, all, or comma-separated combination"
}

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

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "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

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "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"
}