Create a data source definition

post/providers/{providerId}/sourceDefinitions

Creates a date source definition from the provided request.

Request Samples

1

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": "pathdnfs",
8 "providerId": "Compute",
9 "description": "description for source definition for base SAS",
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

NameTypeRequiredDescription
providerId
string
true

The ID for the provider.

Request Body

Source definition to create. The only fields validated are providerId and defaultLibref. Other fields are not validated. The attributes are not required for the source definition but they are needed to actually use the source definition to access tables.

Information about a data source definition.

NameTypeRequiredDescription
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 of 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

StatusMeaningDescription
201Created

A source definition was created.

HeadersSchema
400Bad Request

The request was invalid.

Schema
404Not Found

No provider exists at the requested path.

Schema