Update a data source definition

put/providers/{providerId}/sourceDefinitions/{sourceDefinitionId}

Updates an existing data source definition through a full replacement of the resource. The ID field might not be modified by this operation.

Request Samples

Response Samples


1{
2  "creationTimeStamp": "0001-01-01T00:00:00Z",
3  "modifiedTimeStamp": "0001-01-01T00:00:00Z",
4  "createdBy": "sasjoe",
5  "modifiedBy": "sasjoe",
6  "id": "ea1a9f8a-5013-4c89-8298-78c95659782e",
7  "name": "pdnfsmod",
8  "providerId": "Compute",
9  "description": "A description for source definition for base pathdnfs",
10  "dataSourceId": "SAS Studio compute context",
11  "defaultLibref": "pathdnfs",
12  "attributes": {
13    "engineName": "sase7",
14    "options": {
15      "ENABLEDIRECTIO": "NO",
16      "NOSETPERM": "NO",
17      "USEDIRECTIO": "NO"
18    },
19    "physicalName": "/dmtesting/custom_steps/Loqate/sample_data"
20  },
21  "version": 2,
22  "links": [
23    {
24      "method": "GET",
25      "rel": "self",
26      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
27      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
28      "type": "application/vnd.sas.data.source.definition"
29    },
30    {
31      "method": "PUT",
32      "rel": "update",
33      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
34      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
35      "type": "application/vnd.sas.data.source.definition"
36    },
37    {
38      "method": "DELETE",
39      "rel": "delete",
40      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
41      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e"
42    },
43    {
44      "method": "PUT",
45      "rel": "export",
46      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
47      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
48      "type": "application/vnd.sas.transfer.object"
49    },
50    {
51      "method": "PUT",
52      "rel": "import",
53      "href": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
54      "uri": "/dataSources/providers/Compute/sourceDefinitions/ea1a9f8a-5013-4c89-8298-78c95659782e",
55      "type": "application/vnd.sas.transfer.object",
56      "responseType": "application/vnd.sas.summary"
57    },
58    {
59      "method": "GET",
60      "rel": "up",
61      "href": "/dataSources/providers/Compute/sourceDefinitions",
62      "uri": "/dataSources/providers/Compute/sourceDefinitions",
63      "type": "application/vnd.sas.collection",
64      "itemType": "application/vnd.sas.data.source.definition"
65    },
66    {
67      "method": "GET",
68      "rel": "provider",
69      "href": "/dataSources/providers/Compute",
70      "uri": "/dataSources/providers/Compute",
71      "type": "application/vnd.sas.data.provider"
72    }
73  ]
74}

Path Parameters

Name	Type	Required	Description
providerId	string	true	The ID for the provider.
sourceDefinitionId	string	true	The ID for the source definition.

Header Parameters

Name	Type	Required	Description
If-Match	string	false	The etag that was returned from a GET, POST, or PUT of this data source definition.

Request Body

The source definition to update.

Information about a data source definition.

Name	Type	Required	Description
id	string	true	The unique data source definition identifier. <= 36 characters
providerId	string	true	The provider identifier. >= 1 characters<= 36 characters
name	string	true	The non-unique name for the data source definition. >= 1 characters<= 250 characters
description	string	false	A brief description for the data source definition. >= 0 characters<= 1000 characters
dataSourceId	string	false	The non-unique identifier for the associated data source. >= 0 characters<= 2048 characters
defaultLibref	string	false	A libref for use when LIBNAME statement is auto generated. >= 1 characters<= 8 characters
attributes	object	false	The map of attribute names to values for this source definition. The contents of this field usually include data source engine properties and options just like the ones used in defining a library using a LIBNAME statement. Refer to compute service engines API `engines` for engine and options information. The value of each attribute may be of types: number, string, boolean, or object like a map. If an attribute does not have a value, the value should be set to null.
version	integer	false	The source definition schema version.

Responses

Status	Meaning	Description
200	OK	The request succeeded. Data source definition updated successfully.	Headers	Schema
400	Bad Request	The request was invalid. This occurs when the user provides an ID in the request that does not match the ID in the path of the URL.		Schema
404	Not Found	No data source definition exists at the requested path.		Schema
406	Not Acceptable	This is an example of an error that could be returned for unsupported requested media type.		Schema
412	Precondition Failed	The ETag provided does not match the current version of the object.		Schema
428	Precondition Required	The If-Match header was not provided when updating an existing type.		Schema