Update a global variable

put/globalVariables/{globalVariableId}

Internal-Use Only

Updates the specified global variable

Request Samples

application/vnd.sas.data.reference.global.variable+json
1

Response Samples

200
application/vnd.sas.data.reference.global.variable+json
1{
2  "creationTimeStamp": "2023-01-17T16:29:31.851Z",
3  "modifiedTimeStamp": "2023-01-17T16:29:31.856Z",
4  "createdBy": "userx",
5  "modifiedBy": "userx",
6  "id": "38b4d801-f744-45cf-8e97-12a109daf3af",
7  "activeVersionId": "8eb475bb-4a78-46ea-bb0b-a74206b3fc0e",
8  "majorRevision": 1,
9  "minorRevision": 1,
10  "name": "gv_string_hmeq_value",
11  "dataType": "string",
12  "defaultValue": "exampleValue",
13  "hidden": false,
14  "status": "developing",
15  "locked": false,
16  "links": [
17    {
18      "method": "GET",
19      "rel": "self",
20      "href": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af",
21      "uri": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af",
22      "responseType": "application/vnd.sas.data.reference.global.variable"
23    },
24    {
25      "method": "PUT",
26      "rel": "update",
27      "href": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af",
28      "uri": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af",
29      "type": "application/vnd.sas.data.reference.global.variable",
30      "responseType": "application/vnd.sas.data.reference.global.variable"
31    },
32    {
33      "method": "DELETE",
34      "rel": "delete",
35      "href": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af",
36      "uri": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af"
37    },
38    {
39      "method": "GET",
40      "rel": "revisions",
41      "href": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af/revisions",
42      "uri": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af/revisions",
43      "responseType": "application/vnd.sas.collection",
44      "itemType": "application/vnd.sas.data.reference.global.variable"
45    },
46    {
47      "method": "GET",
48      "rel": "currentRevision",
49      "href": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af",
50      "uri": "/referenceData/globalVariables/38b4d801-f744-45cf-8e97-12a109daf3af",
51      "responseType": "application/vnd.sas.data.reference.global.variable"
52    }
53  ]
54}

Path Parameters

Name	Type	Required	Description
globalVariableId	string	true	The identifier of a global variable.

Header Parameters

Name	Type	Required	Description
If-Match	string	true	The ETag value that was returned from a GET, or POST.

Request Body

The global variable representation. Only the name, type and value are required.

Represents a global variable that can be defined and used across decisions and rule sets.

Name	Type	Required	Description
id	string	false	The system-assigned unique ID for this object.
name	string	true	Name of the global variable.
description	string	false	Description of the global variable
defaultValue	string	true	The value of the global variable. Applicable to all decisions and rule sets where it is referenced. It can also be overridden in a decision or rule set.
createdBy	string	false	The user who created the global variable. The value for this attribute is assigned by the system.
creationTimeStamp	string<date-time>	false	The date and time that the global variable was created. The value for this attribute is assigned by the system.
modifiedBy	string	false	The user ID of the authenticated user who last updated the global variable. The value for this attribute is assigned by the system.
modifiedTimeStamp	string<date-time>	false	The date and time that the global variable was last modified. The value for this attribute is assigned by the system.
dataType	string<enumeration>	true	The type of data that the global variable is intended to be used with. Allowed values: stringdecimalintegerdatedatetimeboolean
majorNumber	integer	false	The major version number. The value for this attribute is assigned by the system.
minorNumber	integer	false	The minor version number. The value for this attribute is assigned by the system.
status	string	false	The status of global variable. The value for this attribute is assigned by the system. Allowed values: developingproduction
locked	boolean	false	Flag that indicates whether the content of the revision being viewed is locked or editable. The value for this attribute is assigned by the system.
activeVersionId	string	false	The system-assigned unique ID for the active version.
links	array [Link]	false	Links to related resources or operations.

Responses

Status	Meaning	Description
200	OK	The global variable was replaced.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	No resource exists at the requested path. Resource is not found.		Schema
412	Precondition Failed	The ETag value used in the If-Match header did not match the resource's ETag value.		Schema
428	Precondition Required	The request headers did not include a `If-Match` precondition.		Schema