Post Data from an Amazon S3 Data Source

Use the POST method to stream data from an Amazon S3 data source.

Syntax 

HTTP method

POST

Availability

Version 51.0 and later.

Formats

REST

URI

/services/data/<vZZ.0>/ui-api/records

Substitute ZZ with the version of the API.

Note

Example 

URI

1Post /services/data/v51.0/ui-api/records

Request Body

1{
2  "apiName": "DataStream",
3  "fields": {
4    "Name": "{DATA STREAM NAME}",
5    "DataStreamDefinitionId" : "{DATA STREAM DEFINITION ID}",
6    "RefreshFrequency": "Hourly",
7    "RefreshMode" : "Upsert"
8  }
9}

Request parameters

Parameter	Description
apiName	Name of the entity that you’re creating.
Name	The name of the data stream.
DataStreamDefinitionId	The id of the data stream definition that must be associated with the data stream. This id must be available when you create the setup entities via metadata API CRUD or deploy.
RefreshFrequency	None, Hourly, Weekly: You must provide the day of the week via: RefreshDayOfWeek. Monthly: You must provide the day of the month via: RefreshDayOfMonth
RefreshMode	Upsert and Full_Refresh are supported.

Response

1{
2    "apiName": "DataStream",
3    "childRelationships": {},
4    "eTag": "9e9cb5c9a3e9db2e75918fa9b5b20815",
5    "fields": {
6        "CreatedBy": {
7            "displayValue": "Admin User",
8            "value": {
9                "apiName": "User",
10                "childRelationships": {},
11                "eTag": "8941f8da5501cf307f51e59c936e434b",
12                "fields": {
13                    "Id": {
14                        "displayValue": null,
15                        "value": "005R0000000d9SfIAI"
16                    },
17                    "Name": {
18                        "displayValue": null,
19                        "value": "Admin User"
20                    }
21                },
22                "id": "005R0000000d9SfIAI",
23                "lastModifiedById": "005R0000000d9SfIAI",
24                "lastModifiedDate": "2021-03-24T19:03:56.000Z",
25                "recordTypeId": null,
26                "recordTypeInfo": null,
27                "systemModstamp": "2021-03-31T22:47:39.000Z",
28                "weakEtag": 1617230859000
29            }
30        },
31        "CreatedById": {
32            "displayValue": null,
33            "value": "005R0000000d9SfIAI"
34        },
35        "CreatedDate": {
36            "displayValue": "4/2/2021, 2:50 PM",
37            "value": "2021-04-02T21:50:23.000Z"
38        },
39        "DataStreamStatus": {
40            "displayValue": "Processing",
41            "value": "PROCESSING"
42        },
43        "ImportRunStatus": {
44            "displayValue": "None",
45            "value": "NONE"
46        },
47        "IsRefreshDeliveryHourAutomatic": {
48            "displayValue": null,
49            "value": false
50        },
51        "LastNumberOfRowsAddedCount": {
52            "displayValue": null,
53            "value": null
54        },
55        "LastRefreshDate": {
56            "displayValue": null,
57            "value": null
58        },
59        "Name": {
60            "displayValue": null,
61            "value": "s3-ui-api"
62        },
63        "RefreshDayOfMonth": {
64            "displayValue": null,
65            "value": null
66        },
67        "RefreshDayOfWeek": {
68            "displayValue": null,
69            "value": null
70        },
71        "RefreshFrequency": {
72            "displayValue": "Hourly",
73            "value": "HOURLY"
74        },
75        "RefreshHours": {
76            "displayValue": null,
77            "value": null
78        },
79        "RefreshMode": {
80            "displayValue": "Upsert",
81            "value": "UPSERT"
82        },
83        "TotalNumberOfRowsAdded": {
84            "displayValue": null,
85            "value": null
86        },
87        "TotalRowsProcessed": {
88            "displayValue": null,
89            "value": null
90        }
91    },
92    "id": "1dsR000000002zzIAA",
93    "lastModifiedById": "005R0000000d9SfIAI",
94    "lastModifiedDate": "2021-04-02T21:50:23.000Z",
95    "recordTypeId": "012000000000000AAA",
96    "recordTypeInfo": null,
97    "systemModstamp": "2021-04-02T21:50:23.000Z",
98    "weakEtag": 1617400223000
99}