Update a code file

put/codeFiles/{codeFileId}

Internal-Use Only

Updates a code file based on the representation in the request body. Only the name and description of a code file can be updated with this operation.

Request Samples

application/json
1

Response Samples

200
application/json
1{
2  "creationTimeStamp": "2021-05-06T20:21:04.420Z",
3  "modifiedTimeStamp": "2021-05-06T20:21:04.882Z",
4  "createdBy": "sasdemo",
5  "modifiedBy": "sasdemo",
6  "id": "cd404a82-af5b-4835-9672-9730470a6be8",
7  "name": "add_cf",
8  "majorRevision": 1,
9  "minorRevision": 0,
10  "checkout": false,
11  "locked": false,
12  "type": "decisionDS2CodeFile",
13  "signature": [
14    {
15      "name": "a",
16      "dataType": "decimal",
17      "direction": "input"
18    },
19    {
20      "name": "b",
21      "dataType": "decimal",
22      "direction": "input"
23    },
24    {
25      "name": "c",
26      "dataType": "decimal",
27      "direction": "output"
28    }
29  ],
30  "status": "valid",
31  "links": [
32    {
33      "method": "GET",
34      "rel": "up",
35      "href": "/decisions/codeFiles",
36      "uri": "/decisions/codeFiles",
37      "type": "application/vnd.sas.collection",
38      "itemType": "application/vnd.sas.decision.code.file"
39    },
40    {
41      "method": "GET",
42      "rel": "self",
43      "href": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
44      "uri": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
45      "type": "application/vnd.sas.decision.code.file"
46    },
47    {
48      "method": "PUT",
49      "rel": "update",
50      "href": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
51      "uri": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
52      "type": "application/vnd.sas.decision.code.file"
53    },
54    {
55      "method": "GET",
56      "rel": "alternate",
57      "href": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
58      "uri": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
59      "type": "application/vnd.sas.summary"
60    },
61    {
62      "method": "GET",
63      "rel": "content",
64      "href": "/files/files/2110f410-bb15-41d4-a0a5-e707fececfe9/content",
65      "uri": "/files/files/2110f410-bb15-41d4-a0a5-e707fececfe9/content"
66    },
67    {
68      "method": "GET",
69      "rel": "decisionStepCode",
70      "href": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
71      "uri": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
72      "type": "application/vnd.sas.decision.step.code"
73    },
74    {
75      "method": "GET",
76      "rel": "revisions",
77      "href": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8/revisions",
78      "uri": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8/revisions",
79      "type": "application/vnd.sas.collection"
80    },
81    {
82      "method": "DELETE",
83      "rel": "delete",
84      "href": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8",
85      "uri": "/decisions/codeFiles/cd404a82-af5b-4835-9672-9730470a6be8"
86    }
87  ],
88  "sourceRevisionUri": "/decisions/codeFiles/57d3b887-472b-4bd5-a021-b6f336efed41/revisions/200b0999-08ae-4371-a06c-f08d8c246f64",
89  "copyTimeStamp": "2021-05-06T20:21:04.490Z",
90  "fileUri": "/files/files/2110f410-bb15-41d4-a0a5-e707fececfe9",
91  "version": 2
92}

Path Parameters

Name	Type	Required	Description
codeFileId	string	true	The identifier for the decision.

Header Parameters

Name	Type	Required	Description
If-Match	string	true	The `ETag` value from when the originating object was retrieved.

Request Body

The unique identifier for the code file.

Wrapper to file resource, which contains the signature of the code. This represents application/vnd.sas.decision.code.file media type (version 9).

Name	Type	Required	Description
id	string	false	The system-assigned unique ID for this object.
name	string	false	The code file name.
description	string	false	The code file description.
createdBy	string	false	The user who created the code file.
creationTimeStamp	string<date-time>	false	The date and time that the code file was created.
modifiedBy	string	false	The user ID of the authenticated user who last updated the code file.
modifiedTimeStamp	string<date-time>	false	The date and time that the code file was last modified.
majorRevision	integer	false	Major version number of the revision being viewed of the code file. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field that is generated on POST.
minorRevision	integer	false	Minor version number of the current revision of the code file. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field that is generated on POST.
checkout	boolean	false	Flag indicating that the code file is the user's working copy of another code file.
locked	boolean	false	Flag which indicates whether the content of the revision being viewed is locked or editable.
type	string<enumeration>	true	Type of the code. Allowed values: decisionCustomContextDS2CodeFiledecisionDS2CodeFiledecisionSQLCodeFiledecisionPythonFile
status	string<enumeration>	false	Status of the code content. Allowed values: validerror
errorCode	integer	false	Error code when parsing code content.
errorMessage	string	false	Error message when parsing code content.
signature	array [Code File Signature Term]	false	Array of signature terms.
folderType	string	false	Indicates the type of folder where the code file is located.
sourceRevisionUri	string	false	The URI of the code file revision this code file is being created from.
copyTimeStamp	string<date-time>	false	The time stamp when the code file revision was copied.
links	array [Link]	false	Zero or more links to related resources or operations.
fileUri	string	true	The URI of the file resource, which contains code.
testCustomContextUri	string	false	The URI of a Custom Context DS2 code file that provides a custom context to this code file. Normally, this code file's custom context is provided by the decision that utilizes it. For syntax validation and testing purpose, you can specify a testing-only custom context.
version	integer	false	This media type's schema version number. This representation is version 9.

Responses

Status	Meaning	Description
200	OK	The code file was updated.	Headers	Schema
400	Bad Request	The request was invalid.	Headers	Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag.	Headers	Schema
428	Precondition Required	The request headers did not include a `If-Match` precondition.	Headers	Schema