Update an existing administrator workflow setting

put/settings/administrators/{settingId}

Internal-Use Only

Updates an existing administrator workflow setting.

Request Samples

application/vnd.sas.investigation.workflow.setting+json
1

Response Samples

200
application/vnd.sas.investigation.workflow.setting+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "self",
6      "href": "/svi-datahub/workflows/settings/administrators/TASKS_TAB_COLUMNS",
7      "uri": "/svi-datahub/workflows/settings/administrators/TASKS_TAB_COLUMNS",
8      "type": "application/vnd.sas.investigation.workflow.setting",
9      "responseType": "application/vnd.sas.investigation.workflow.setting+json"
10    },
11    {
12      "method": "PUT",
13      "rel": "update",
14      "href": "/svi-datahub/workflows/settings/administrators/TASKS_TAB_COLUMNS",
15      "uri": "/svi-datahub/workflows/settings/administrators/TASKS_TAB_COLUMNS",
16      "type": "application/vnd.sas.investigation.workflow.setting",
17      "responseType": "application/vnd.sas.investigation.workflow.setting+json"
18    },
19    {
20      "method": "DELETE",
21      "rel": "delete",
22      "href": "/svi-datahub/workflows/settings/administrators/TASKS_TAB_COLUMNS",
23      "uri": "/svi-datahub/workflows/settings/administrators/TASKS_TAB_COLUMNS"
24    }
25  ],
26  "version": 1,
27  "id": "TASKS_TAB_COLUMNS",
28  "user": "<svi_administrator>",
29  "columns": {
30    "defaultColumns": [
31      {
32        "name": "isClaimedByCurrentUser",
33        "order": 1
34      },
35      {
36        "name": "entityLabel",
37        "order": 2
38      },
39      {
40        "name": "entityInstanceLabel",
41        "order": 3
42      },
43      {
44        "name": "name",
45        "order": 4
46      },
47      {
48        "name": "workflowLabel",
49        "order": 5
50      },
51      {
52        "name": "claimedAt",
53        "order": 6
54      },
55      {
56        "name": "assignee",
57        "order": 7
58      },
59      {
60        "name": "createdAt",
61        "order": 8
62      },
63      {
64        "name": "dueDateTimestamp",
65        "order": 9
66      }
67    ],
68    "defaultSort": [
69      {
70        "name": "isClaimedByCurrentUser",
71        "direction": "ascending",
72        "order": 1
73      },
74      {
75        "name": "dueDateTimestamp",
76        "direction": "ascending",
77        "order": 2
78      }
79    ]
80  },
81  "createdAt": "2023-08-01T21:39:31.048Z",
82  "createdBy": "<svi_db_user>",
83  "lastUpdatedAt": "2023-08-04T16:12:55.145Z",
84  "lastUpdatedBy": "videmo"
85}

Path Parameters

Name	Type	Required	Description
settingId	string	true	The ID of the setting.

Header Parameters

Name	Type	Required	Description
Content-Type	string	false	The version of the workflow setting in the body.
If-Unmodified-Since	integer<int64>	false	The time at which this setting was last modified.

Request Body

A representation of workflow settings applied per user.

Name	Type	Required	Description
createdAt	string<date-time>	false	The time of creation.
createdBy	string	false	The name of the user who created the settings.
lastUpdatedAt	string<date-time>	false	The time of the last update.
columns	columnSettingRep	false	A collection of settings for displaying grid columns.
links	array [Link]	false	The links that apply to this resource.
id	string	false	The ID of the setting.
user	string	false	The name of user for these settings.
version	integer<int32>	false	This media type's schema version number. This representation is version 1.
lastUpdatedBy	string	false	The name of the user who last updated the settings.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	No setting exists at the requested path.		Schema
412	Precondition Failed	The If-Match request header did not match the resource's entity tag, or the If-Unmodified-Since request header did not match the resource's last modified timestamp.		Schema
428	Precondition Required	The request headers did not include an If-Match or If-Unmodified-Since precondition.		Schema