SERVICE API GUIDE


Table of Contents

About

This document is provided as a reference for developers who want to write code which interacts with the solution accelerator, essentially by using any available data that can provide big data solutions.

Configuration Service

Query Configuration Entry

Description

Query a configuration entry by its key.

Request

Request Examples

Get/configuration?key=MdmServiceUrlHTTP/1.1
Host: config.contoso.com
Content-Length: 0

Request URI Parameters

Configuration Service - Request URI Parameters.PNG

Request Headers

N/A

Request Body

N/A

Request Security

Configuration Service - Request Security.PNG

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Query Config Entry - Response Examples script.PNG

Response Status Code

Configuration Service - Request Status Code.PNG

Response Headers

N/A

Response Body

JSON formatted data of the configuration entry, as shown below:
Query Config Entry - Response Body script.PNG

Configuration Service - Response Body.PNG

Back to top


Data Source Management Service (DSM)

Retrieve Pull Channels

Description

Executing an HTTP GET request against the pull channel collection will retrieve a list of all existing pull channels; especially if the channel’s name/driver name is provided (only the channels that match the criteria are listed).

Request

Request Examples

Gethttp://localhost:8004/pull/channel/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Pull Channels - Request URI Parameters.PNG

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Pull Channels - Request Security.PNG

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Pull Channels - Response Examples script.PNG
Retrieve Pull Channels - Response Examples script 2.PNG

Response Status Code

Retrieve Pull Channels - Response Status Code.PNG

Response Headers

N/A

Response Body

A JSON formatted list for Channel, as shown below:

Retrieve Pull Channels - Response Body script.PNG
Retrieve Pull Channels - Response Body script 2.PNG

DataContract - Channel
Retrieve Pull Channels - DataContract Channel.PNG

DataContract – PluginSetting
Retrieve Pull Channels - DataContract Plugin Settings.PNG

Back to top


Mutate a Pull Channel

Description

A new pull channel can be created, or an existing pull channel can be updated by executing an HTTP POST request against the pull channel mutate interface.

Request

Request Examples

POSThttp://localhost:8004/pull/channel/mutateHTTP/1.1
Host: localhost:8004
Content-Type: application/json
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 189

Mutate a Pull Channel - Request Examples script.PNG

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for Channel

Request Security

Mutate a Pull Channel - Request Security.PNG

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Mutate a Pull Channel - Response Status Code.PNG

Response Headers

N/A

Response Body

N/A

Back to top


Delete a Pull Channel

Description

Delete an existing channel by its name.

Request

Request Examples

Gethttp://localhost:8004/pull/channel/delete?name=AQIWebChannelHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Delete a Pull Channel - Request URI Parameters.PNG

Request Headers

N/A

Request Body

N/A

Request Security

Delete a Pull Channel - Request Security.PNG

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Delete a Pull Channel - Response Status Code.PNG

Response Headers

N/A

Response Body

N/A

Back to top


Validate a Pull Channel Reference

Description

Verify the validity of the channel reference by providing a channel name and its runtime settings.

Request

Request Examples

POSThttp://localhost:8004/pull/channel/validate HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 124

Validate a Pull Channel Reference - Request Examples script.PNG

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for ChannelReferenceRequest, as shown below:

Validate a Pull Channel Reference - Request Body script.PNG

DataContract – ChannelReferenceRequest/ChannelReference
Validate a Pull Channel Reference - DataContract – ChannelReferenceRequestChannelReference.PNG

Request Security

Validate a Pull Channel Reference - Request Security.PNG

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Validate a Pull Channel Reference - Response Examples script.PNG

Response Status Code

Validate a Pull Channel Reference - Response Status Code.PNG

Response Headers

N/A

Response Body

A JSON formatted instance for ValidationResponse, as shown below:

Validate a Pull Channel Reference - Response Body script.PNG

DataContract - ValidationResponse
Validate a Pull Channel Reference - DataContract - ValidationResponse.PNG

Back to top


Validate a Pull Channel Name

Description

Check if the provided channel name is available.

Request

Request Examples

Gethttp://localhost:8004/pull/channel/name/validate?name=ANewChannelHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Validate a Pull Channel Name - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Validate a Pull Channel Name - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

true

Response Status Code

Validate a Pull Channel Name - Response Status Code.png

Response Headers

N/A

Response Body

True or false; true means that the submitted channel name is available, otherwise false. As shown below:
true

Back to top


Retrieve Pull Sources

Description

Executing an HTTP GET request against the pull source collection will retrieve a list of existing pull sources; especially if the source’s name/IsTest is provided (only the source that matches the criteria is listed).

Request

Request Examples

Gethttp://localhost:8004/pull/source/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Pull Sources - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Pull Sources - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Pull Sources - Response Examples script.png
Retrieve Pull Sources - Response Examples script 2.png
Retrieve Pull Sources - Response Examples script 3.png
Retrieve Pull Sources - Response Examples script 4.png
Retrieve Pull Sources - Response Examples script 5.png
Retrieve Pull Sources - Response Examples script 6.png
Retrieve Pull Sources - Response Examples script 7.png

Response Status Code

Retrieve Pull Sources - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for PullSourceResponse, as shown below:

Retrieve Pull Sources - Response Body script.png
Retrieve Pull Sources - Response Body script 2.png
Retrieve Pull Sources - Response Body script 3.png
Retrieve Pull Sources - Response Body script 4.png

DataContract - PullSourceResponse
Retrieve Pull Sources - DataContract - PullSourceResponse.png

DataContract – ChannelReferenceResponse
Retrieve Pull Sources - DataContract – ChannelReferenceResponse.png

Back to top



Mutate a Pull Source

Description

A new pull source can be created or an existing pull source can be updated by executing an HTTP POST request against the pull source mutate interface.

Request

Request Examples

POST http://localhost:8004/pull/source/mutateHTTP/1.1
Host: localhost:8004
Content-Type: application/json
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 770

Mutate a Pull Source - Request Examples script.png
Mutate a Pull Source - Request Examples script 2.png
Mutate a Pull Source - Request Examples script 3.png

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for PullSourceRequest, as shown below:

Mutate a Pull Source - Request Body script.png
Mutate a Pull Source - Request Body script 2.png
Mutate a Pull Source - Request Body script 3.png

DataContract - PullSourceRequest
Mutate a Pull Source - DataContract - PullSourceRequest.png

Request Security

Mutate a Pull Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 17
"NYCEventFileCSV"

Response Status Code

Mutate a Pull Source - Response Status Code.png

Response Headers

N/A

Response Body

The pull source name that has been mutated into JSON format.

Back to top



Delete a Pull Source

Description

Delete an existing pull source by its name.

Request

Request Examples

Gethttp://localhost:8004/pull/source/delete?name=NYCEventFileCSV HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Delete a Pull Source - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Delete a Pull Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Delete a Pull Source - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Validate a Pull Source Name

Description

Check if the provided pull source name is available.

Request

Request Examples

Gethttp://localhost:8004/pull/source/validate?name=ANewPullSource HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Validate a Pull Source Name - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Validate a Pull Source Name - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

true

Response Status Code

Validate a Pull Source Name - Response Status Code.png

Response Headers

N/A

Response Body

True or false; true means the submitted pull source name is available, otherwise false. As shown below:
true

Back to top



Enable/Disable a Pull Source

Description

Enable or disable an existing pull source.

Request

Request Examples

Gethttp://localhost:8004/pull/source/control?name=NYCEventFileCSV&disable=true HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

EnableDisable a Pull Source - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

EnableDisable a Pull Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

EnableDisable a Pull Source - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve Pull Events

Description

Retrieve the pull events which consist of the pull pipeline executing information, including the process checkpoint information; this may also include the detailed failures. Pagination and other search criteria are provided.

Request

Request Examples

Gethttp://localhost:8004/pull/event/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Pull Events - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Pull Events - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Pull Events - Response Examples script.png
Retrieve Pull Events - Response Examples script 2.png

Response Status Code

Retrieve Pull Events - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for PullEvent, as shown below:

Retrieve Pull Events - Response Body script.png
Retrieve Pull Events - Response Body script 2.png

DataContract - PullEvent
Retrieve Pull Events - DataContract - PullEvent.png

Back to top



Report Pull Status

Description

Internally used by data ingestion pull channels. This API records the progress information/checkpoint/failures of the data ingestion pipeline, including the information from the plugins (also reports and logs the pull status).

Request

Request Examples

POST http://localhost:8004/pull/event/report?lockID=da6d046f-caee-466c-b7b8-58d43acb8e78HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 153

Information: Apply the DataTable filter 'ComputedColumnFilter' to DataTables, source id:5, source name:'NYCEventFileCSV'

Information: Primary Keys: ID

Request URI Parameters

Report Pull Status - Request URI Parameters.png

Request Headers

N/A

Request Body

A string of information represents the event.

Request Security

Report Pull Status - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Report Pull Status - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve Pull Source Test Run Results

Description

Internally used by Management Studio. Retrieves the latest test run results regarding the specified pull source.

Request

Request Examples

Gethttp://localhost:8004/pull/source/testresult?sourceName=AQIWebHtml|FA80C203-AA3F-46B9-BE59-1B4208E70B1CHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Pull Source Test Run Results - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Pull Source Test Run Results - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Pull Source Test Run Results - Response Examples script.png

Response Status Code

Retrieve Pull Source Test Run Results - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted instance for TestResult, as shown below:

Retrieve Pull Source Test Run Results - Response Body script.png

DataContract - TestResult
Retrieve Pull Source Test Run Results - DataContract - TestResult.png

Back to top


Retrieve Pull Source Last Run Status

Description

Get the last run status of the pull source; a list of the source names that you want to retrieve should be provided.

Request

Request Examples

POST http://localhost:8004/pull/source/lastrunstatusHTTP/1.1
Host: localhost:8004
Content-Type: application/json
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 32

"AQIWebHtml","NYCEventFileCSV"

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON string array regarding the pull source name.

Request Security

Retrieve Pull Source Last Run Status - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Pull Source Last Run Status - Response Examples script.png

Response Status Code

Retrieve Pull Source Last Run Status - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list of key value pairs regarding the pull source name and the RunStatus, as shown below:

Retrieve Pull Source Last Run Status - Response Body script.png
Retrieve Pull Source Last Run Status - Response Body script 2.png

DataContract - RunStatus
Retrieve Pull Source Last Run Status - DataContract - RunStatus.png

Back to top



Retrieve Pull Schedules

Description

Retrieve all of the pull schedules regarding the provided pull data source.

Request

Request Examples

Gethttp://localhost:8004/pull/schedule/get?pullDataSourceName=NYCEventFileCSVHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Pull Schedules - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Pull Schedules - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Pull Schedules - Response Examples script.png
Retrieve Pull Schedules - Response Examples script 2.png

Response Status Code

Retrieve Pull Schedules - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for ScheduleEntity, as shown below:

Retrieve Pull Schedules - Response Body script.png
Retrieve Pull Schedules - Response Body script 2.png

DataContract - ScheduleEntity
Retrieve Pull Schedules - DataContract - ScheduleEntity.png

Back to top



Create a Pull Schedule

Description

A new schedule for a specified pull data source can be created by executing an HTTP POST request against the pull schedule create interface.

Request

Request Examples

POST http://localhost:8004/pull/schedule/create HTTP/1.1
Host: localhost:8004
Content-Type: application/json
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 131

Create a Pull Schedule - Request Examples script.png

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for AddScheduleRequest, as shown below:

Create a Pull Schedule - Request Body script.png

DataContract - AddScheduleRequest
Create a Pull Schedule - DataContract - AddScheduleRequest.png

Request Security

Create a Pull Schedule - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 38

"0c118666-5250-4eef-9d87-89aa78508371"

Response Status Code

Create a Pull Schedule - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted string about the new created schedule ID.

Back to top


Delete a Pull Schedule

Description

Delete an existing schedule by its ID.

Request

Request Examples

Gethttp://localhost:8004/pull/schedule/delete?id=0C118666-5250-4EEF-9D87-89AA78508371HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Delete a Pull Schedule - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Delete a Pull Schedule - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Delete a Pull Schedule - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Lock a Pull Source

Description

Internally used by the data ingestion pull controller, lock a pull source which has the schedule as active and is about to run.

Request

Request Examples

Gethttp://localhost:8004/pull/source/lock?lockID=8efed13e-8f88-4e3f-a445-7f7a07052f48&expiredTime=86400HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Lock a Pull Source - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Lock a Pull Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 5
false

Response Status Code

Lock a Pull Source - Response Status Code.png

Response Headers

N/A

Response Body

True/false; a flag indicates whether an active schedule has been locked or not locked.

Back to top



Unlock a Pull Source

Description

Internally used by the data ingestion component. The provided lock ID will unlock the pull source, release the lock and submit the running result (if unsuccessful, a detailed error message or the test run result will be displayed).

Request

Request Examples

POST http://localhost:8004/pull/source/unlock?lockID=da6d046f-caee-466c-b7b8-58d43acb8e78HTTP/1.1
Host: localhost:8004
Content-Type: application/json
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 87

Unlock a Pull Source - Request Examples script.png

Request URI Parameters

Unlock a Pull Source - Request URI Parameters.png

Request Headers

N/A

Request Body

A JSON formatted instance for TestResult, as shown below:

Unlock a Pull Source - Request Body script.png

Request Security

Unlock a Pull Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Unlock a Pull Source - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve a Pull Source with Lock ID

Description

Internally used by the data ingestion component. The lock ID will retrieve the pull source.

Request

Request Examples

Gethttp://localhost:8004/pull/source/locked/get?lockID=da6d046f-caee-466c-b7b8-58d43acb8e78HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve a Pull Source with Lock ID - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve a Pull Source with Lock ID - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve a Pull Source with Lock ID - Response Examples script.png
Retrieve a Pull Source with Lock ID - Response Examples script b.png
Retrieve a Pull Source with Lock ID - Response Examples script c.png

Response Status Code

Retrieve a Pull Source with Lock ID - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted instance for PullSourceResponse, as shown below:

Retrieve a Pull Source with Lock ID - Response Body script.png
Retrieve a Pull Source with Lock ID - Response Body script b.png
Retrieve a Pull Source with Lock ID - Response Body script c.png

Back to top



Retrieve Push Sources

Description

Executing an HTTP GET request against the push source collection will retrieve a list of existing push sources, especially if the source’s name/isTest is provided (only the source that matches the criteria is listed).

Request

Request Examples

Gethttp://localhost:8004/push/source/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Push Sources - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Push Sources - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Push Sources - Response Examples script.png
Retrieve Push Sources - Response Examples script b.png
Retrieve Push Sources - Response Examples script c.png

Response Status Code

Retrieve Push Sources - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted instance for GetPushSourceResponse, as shown below:

Retrieve Push Sources - Response Body script.png
Retrieve Push Sources - Response Body script b.png

DataContract - GetPushSourceResponse
Retrieve Push Sources - DataContract - GetPushSourceResponse.png

DataContract - PushToCamResponse
Retrieve Push Sources - DataContract - PushToCamResponse.png

Back to top



Mutate a Push Source

Description

A new push source can be created, or an existing push source can be updated by executing an HTTP POST request against the push source mutate interface.

Request

Request Examples

POST http://localhost:8004/push/source/mutate?targetType=CAMHTTP/1.1
Host: localhost:8004
Content-Type: application/json
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 378

Mutate a Push Source - Request Examples script.png

Request URI Parameters

Mutate a Push Source - Request URI Parameters.png

Request Headers

N/A

Request Body

A JSON formatted instance for PushToCamRequest, as shown below:

Mutate a Push Source - Request Body script.png

DataContract – PushToCamRequest/PushToCam
Mutate a Push Source - DataContract – PushToCamRequest PushToCam.png

Request Security

Mutate a Push Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 17

"PushNYCEventCSV"

Response Status Code

Mutate a Push Source - Response Status Code.png

Response Headers

N/A

Response Body

The push source name that has been mutated in JSON format.

Back to top



Delete a Push Source

Description

Delete an existing push source by its name.

Request

Request Examples

Gethttp://localhost:8004/push/source/delete?name=KeywordsScoreHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0


!!!!Request URI Parameters
Delete a Push Source - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Delete a Push Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Delete a Push Source - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Validate an Available Push Source Name

Description

Check if the provided push source name is available.

Request

Request Examples

Gethttp://localhost:8004/push/source/validate?name=ANewPushSource HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Validate an Available Push Source Name - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Validate an Available Push Source Name - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

true

Response Status Code

Validate an Available Push Source Name - Response Status Code.png

Response Headers

N/A

Response Body

True or false; true means the submitted push source name is available, otherwise false. As shown below:
true

Back to top



Enable/Disable a Push Source

Description

Enable or disable an existing push source by name.

Request

Request Examples

Gethttp://localhost:8004/push/source/control?name=PushNYCEventCSV&disable=true HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

EnableDisable a Push Source - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

EnableDisable a Push Source - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

EnableDisable a Push Source - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top




Report Push Status

Description

Internally used by the PIS service. Reports and logs the push status (only error information). This API records the failures of the data ingestion pipeline, including the information from the plugins.

Request

Request Examples

POST http://localhost:8004/push/event/report?name=PushToNYCEventsHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAAD4tcj26r41H39dkn1gFSp1GjEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 253

Microsoft.CityNext.IngestionPipeline.Extension.IngestionFatalException: Empty header column at row 1, column 6 at Microsoft.CityNext.IngestionPipeline.StreamConverter.CsvConverter.<OnConvert>d0.MoveNext()


Request URI Parameters

Report Push Status - Request URI Parameters.png

Request Headers

N/A

Request Body

String information which represents the push error.

Request Security

Report Push Status - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Report Push Status - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Download Channel Driver Plugins

Description

Internally used by the data ingestion pull controller and PIS service. Downloads the binary content for the channel driver DLL plugins as a zip file.

Request

Request Examples

Gethttp://localhost:8004/plugin/driver/channel/downloadHTTP/1.1
Host: localhost:8004
Content-Length: 0

Request URI Parameters

N/A

Request Headers

N/A

Request Body

N/A

Request Security

Download Channel Driver Plugins - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Length: length

\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …

Response Status Code

Download Channel Driver Plugins - Response Status Code.png

Response Headers

Download Channel Driver Plugins - Response Headers.png

Response Body

The binary content of the zip file (plugin DLLs), for example:
\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Back to top



Download Stream Converter Plugins

Description

Internally used by the data ingestion pull controller and PIS service. Downloads the binary content for the stream converter DLL plugins as a zip file.

Request

Request Examples

Gethttp://localhost:8004/plugin/converter/stream/downloadHTTP/1.1
Host: localhost:8004
Content-Length: 0

Request URI Parameters

N/A

Request Headers

N/A

Request Body

N/A

Request Security

Download Stream Converter Plugins - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Length: length

\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …

Response Status Code

Download Stream Converter Plugins - Response Status Code.png

Response Headers

Download Stream Converter Plugins - Response Headers.png

Response Body

The binary content of the zip file (plugin DLLs), for example:
\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Back to top



Download Stream Filter Plugins

Description

Internally used by the data ingestion pull controller and PIS service. Downloads the binary content for the stream filter DLL plugins as a zip file.

Request

Request Examples

Gethttp://localhost:8004/plugin/filter/stream/downloadHTTP/1.1
Host: localhost:8004
Content-Length: 0

Request URI Parameters

N/A

Request Headers

N/A

Request Body

N/A

Request Security

Download Stream Filter Plugins - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Length: length

\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Response Status Code

Download Stream Filter Plugins - Response Status Code.png

Response Headers

Download Stream Filter Plugins - Response Headers.png

Response Body

The binary content of the zip file (plugin DLLs), for example:
\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Back to top



Download Data Table Filter Plugins

Description

Internally used by the data ingestion pull controller and PIS service. Downloads the binary content for the data table filter DLL plugins as a zip file.

Request

Request Examples

Gethttp://localhost:8004/plugin/filter/datatable/downloadHTTP/1.1
Host: localhost:8004
Content-Length: 0

Request URI Parameters

N/A

Request Headers

N/A

Request Body

N/A

Request Security

Download Data Table Filter Plugins - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Length: length

\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …

Response Status Code

Download Data Table Filter Plugins - Response Status Code.png

Response Headers

Download Data Table Filter Plugins - Response Headers.png

Response Body

The binary content of the zip file (plugin DLLs), for example:
\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Back to top



Download CCX Extension Plugins

Description

Internally used by the data ingestion pull controller and PIS service. Downloads the binary content for the CCX extension DLL plugins as a zip file.

Request

Request Examples

Gethttp://localhost:8004/plugin/ccx/downloadHTTP/1.1
Host: localhost:8004
Content-Length: 0

Request URI Parameters

N/A

Request Headers

N/A

Request Body

N/A

Request Security

Download CCX Extension Plugins - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Length: length

\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Response Status Code

Download CCX Extension Plugins - Response Status Code.png

Response Headers

Download CCX Extension Plugins - Response Headers.png

Response Body

The binary content of the zip file (plugin DLLs), for example:
\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Back to top



Download All Plugins

Description

Internally used by the data ingestion pull controller and PIS service. Downloads the binary content for all DLL plugins as a zip file.

Request

Request Examples

Gethttp://localhost:8004/plugin/downloadHTTP/1.1
Host: localhost:8004
Content-Length: 0

Request URI Parameters

N/A

Request Headers

N/A

Request Body

N/A

Request Security

Download All Plugins - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Length: length

\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Response Status Code

Download All Plugins - Response Status Code.png

Response Headers

Download All Plugins - Response Headers.png

Response Body

The binary content of the zip file (plugin DLLs), for example:
\x50\x4B\x03\x04\x14\xBB\xCC\xDD\xEE\xFF …


Back to top



Retrieve Channel Drivers

Description

Executing an HTTP GET request against the channel driver plugin collection will retrieve a list of all existing channel driver plugins, especially if the channel driver’s name is provided. Only the description about that channel driver plugin will be returned.

Request

Request Examples

Gethttp://localhost:8004/plugin/driver/channel/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Channel Drivers - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Channel Drivers - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Channel Drivers -Response Examples script.png
Retrieve Channel Drivers -Response Examples script b.png
Retrieve Channel Drivers -Response Examples script c.png

Response Status Code

Retrieve Channel Drivers - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for ChannelDriverMetadata, as shown below:

Retrieve Channel Drivers - Response Body script.png
Retrieve Channel Drivers - Response Body script b.png
Retrieve Channel Drivers - Response Body script c.png
Retrieve Channel Drivers - Response Body script d.png

DataContract - ChannelDriverMetadata
Retrieve Channel Drivers - DataContract - ChannelDriverMetadata.png

DataContract - ConfigMember
Retrieve Channel Drivers - DataContract - ConfigMember.png

Back to top




Retrieve Stream Converters

Description

Executing an HTTP GET request against the stream converter plugin collection will retrieve a list of all existing stream converter plugins, especially if the name of the stream converter is provided. Only the description about that stream converter plugin will be returned.

Request

Request Examples

Gethttp://localhost:8004/plugin/converter/stream/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Stream Converters - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Stream Converters - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Stream Converters - Response Examples script.png

Response Status Code

Retrieve Stream Converters - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for StreamConverterMetadata, as shown below:

Retrieve Stream Converters - Response Body script.png

DataContract – StreamConverterMetadata/DataTableFilterMetadata/StreamFilterMetadata/ConfigurablePluginMetadata
Retrieve Stream Converters - DataContract –.png



Retrieve Data Table Filters

Description

Executing an HTTP GET request against the data table filter plugin collection will retrieve a list of all existing data table filter plugins, especially if the data table filter’s name is provided only the description about that data table filter plugin will be returned.

Request

Request Examples

Gethttp://localhost:8004/plugin/filter/datatable/get HTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Data Table Filters - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Data Table Filters - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Data Table Filters - Response Examples script.png

Response Status Code

Retrieve Data Table Filters - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for DataTableFilterMetadata, as shown below:

Retrieve Data Table Filters - Response Body script.png

Back to top



Retrieve Stream Filters

Description

Executing an HTTP GET request against the stream filter plugin collection will retrieve a list of all existing stream filter plugins, especially if the stream filter’s name is provided. Only the description about that stream filter plugin will be returned.

Request

Request Examples

Gethttp://localhost:8004/plugin/filter/stream/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve Stream Filters - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Stream Filters - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Stream Filters - Response Examples script.png
Retrieve Stream Filters - Response Examples script b.png

Response Status Code

Retrieve Stream Filters - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for StreamFilterMetadata, as shown below:

Retrieve Stream Filters - Response Body script.png
Retrieve Stream Filters - Response Body script b.png

Back to top



Retrieve Computed Column Expression (CCX) Plugins

Description

Executing an HTTP GET request against the Computed Column Expression (CCX) plugin collection will retrieve a list of all existing Computed Column Expression (CCX) plugins, especially if the name of the Computed Column Expression (CCX) is provided. Only the description about that CCX plugin will be returned.

Request

Request Examples

Gethttp://localhost:8004/plugin/ccx/getHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 0

Request URI Parameters

Retrieve CCX Plugins - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve CCX Plugins - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve CCX Plugins - Response Examples script.png

Response Status Code

Retrieve CCX Plugins - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted list for CcxExtensionMetadata, as shown below:

Retrieve CCX Plugins - Response Body script.png

DataContract - CcxExtensionMetadata
Retrieve CCX Plugins - DataContract - CcxExtensionMetadata.png

Back to top



Validate Channel Driver Settings

Description

Verify the validity of the channel driver plugin by providing a channel driver name and its initialization time settings.

Request

Request Examples

POSThttp://localhost:8004/plugin/driver/channel/validateHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 122

Validate Channel Driver Settings - Request Examples script.png

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for PluginSetting, as shown below:

Validate Channel Driver Settings - Request Body script.png

Request Security

Validate Channel Driver Settings - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Validate Channel Driver Settings - Response Examples script.png

Response Status Code

Validate Channel Driver Settings - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted instance for ValidationResponse, as shown below:

Validate Channel Driver Settings - Response Body script.png

Back to top



Validate Stream Converter Settings

Description

Verify the validity of the stream converter plugin by providing a stream converter name and its runtime settings.

Request

Request Examples

POSThttp://localhost:8004/plugin/converter/stream/validateHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 355

Validate Stream Converter Settings - Request Examples script.png

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for PluginSetting, as shown below:

Validate Stream Converter Settings - Request Body script.png

Request Security

Validate Stream Converter Settings - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Validate Stream Converter Settings - Response Examples script.png

Response Status Code

Validate Stream Converter Settings - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted instance for ValidationResponse, as shown below:

Validate Stream Converter Settings - Response Body script.png

Back to top



Validate Stream Filter Settings

Description

Verify the validity of the stream filter plugin by providing a stream filter name and its runtime settings.

Request

Request Examples

POSThttp://localhost:8004/plugin/filter/stream/validateHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 90

Validate Stream Filter Settings - Request Examples script.png

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for PluginSetting, as shown below:

Validate Stream Filter Settings - Request Body script.png

Request Security

Validate Stream Filter Settings - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Validate Stream Filter Settings - Response Examples script.png

Response Status Code

Validate Stream Filter Settings - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted instance for ValidationResponse, as shown below:

Validate Stream Filter Settings - Response Body script.png

Back to top



Validate Data Table Filter Settings

Description

Verify the validity of the data table filter plugin by providing a data table filter name and its runtime settings.

Request

Request Examples

POSThttp://localhost:8004/plugin/filter/datatable/validateHTTP/1.1
Host: localhost:8004
Authorization: Negotiate oXcwdaADCgEBoloEWE5UTE1TU1AAAwAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAAAAAAABYAAAAAAAAAFgAAAAAAAAAWAAAABXCiOIGA4AlAAAADwyg123/NXbJcYmpya5mJx+jEgQQAQAAAPUXp1AtIpqEAAAAAA==
Content-Length: 122

Validate Data Table Filter Settings - Request Examples script.png

Request URI Parameters

N/A

Request Headers

N/A

Request Body

A JSON formatted instance for PluginSetting, as shown below:

Validate Data Table Filter Settings - Request Body script.png

Request Security

Validate Data Table Filter Settings - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Validate Data Table Filter Settings - Response Examples script.png

Response Status Code

Validate Data Table Filter Settings - Response Status Code.png

Response Headers

N/A

Response Body

A JSON formatted instance for ValidationResponse, as shown below:

Validate Data Table Filter Settings - Response Body script.png

Back to top




Push Ingestion Service (PIS)

Push Data (None or Basic Authentication)

Description

The raw data (stream binary data/data table binary data) can be pushed into the data ingestion pipeline for processing by using this interface. The push data source must be predefined in the DSM service before using this interface. None or Basic authentication must be used for this interface.

Request

Request Examples

POST http://localhost:8002/push?sourceName=PushNYCEventCSV&KeyIdentity42312=J42df9KHAOi45lRm7bY6dgqOIX23x1LSHTTP/1.1
Host: localhost:8002
Authorization: Basic S2V5SWRlbnRpdHk0MjMxMjpKNDJkZjlLSEFPaTQ1bFJtN2JZNmRncU9JWDIzeDFMUw==
Content-Length: length

ID,CREATIONDATE,CREATEDBY, TIMEZONE
aaaaaa,2011-07-21 13:51:49.583,TestUserCreate, EST5EDT
bbbbbb,2011-07-21 13:51:49.583,NULL, NULL
cccccc,2011-07-21 13:51:49.583,TestUserCreate, EST5EDT

Request URI Parameters

Push Data None or Basic Authentication - Request URI Parameters.png

Request Headers

Push Data None or Basic Authentication - Request Headers.png

Request Body

The binary raw data; depends on the definition of the push source. As for the request example, it is listed as CSV content.

Request Security

Push Data None or Basic Authentication - Request Security.png

Response

Response Examples

When isTest = false:
HTTP/1.1 200 OK
Content-Length: 0

When isTest = true:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Push Data None or Basic Authentication - Response Examples script.png

Response Status Code

Push Data None or Basic Authentication - Response Status Code.png

Response Headers

N/A

Response Body

When isTest = true, the response is a JSON formatted instance for TestResult, as shown below:

Push Data None or Basic Authentication - Response Body script.png

Back to top


Push Data (Windows Integrated Authentication)

Description

The raw data (stream binary data in various format or data table binary data) can be pushed into the data ingestion pipeline for processing by using this interface. The push data source must be predefined in the DSM service before using this interface. Windows integrated authentication must be used for this interface.

Request

Request Examples

POST http://localhost:8002/push/internal?sourceName=PushNYCEventCSVHTTP/1.1
Host: localhost:8002
Authorization: Negotiate YHcGBisGAQUFAqBtMGugMDAuBgorBgEEAYI3AgIKBgkqhkiC9xIBAgIGCSqGSIb3EgECAgYKKwYBBAGCNwICHqI3BDVOVExNU1NQAAEAAACXsgjiBwAHAC4AAAAGAAYAKAAAAAYDgCUAAAAPU0hJWEk4RkFSRUFTVA==
Content-Length: length

ID,CREATIONDATE,CREATEDBY, TIMEZONE
aaaaaa,2011-07-21 13:51:49.583,TestUserCreate, EST5EDT
bbbbbb,2011-07-21 13:51:49.583,NULL, NULL
cccccc,2011-07-21 13:51:49.583,TestUserCreate, EST5EDT

Request URI Parameters

Push Data Windows Integrated Authentication - Request URI Parameters.png

Request Headers

Push Data Windows Integrated Authentication - Request Headers.png

Request Body

The binary raw data; depends on the definition of the push source. As for the request example, it is listed as CSV content.

Request Security

Push Data Windows Integrated Authentication - Request Security.png

Response

Response Examples

When isTest = false:
HTTP/1.1 200 OK
Content-Length: 0

When isTest = true:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Push Data Windows Integrated Authentication - Response Examples script.png

Response Status Code

Push Data Windows Integrated Authentication - Response Status Code.png

Response Headers

N/A

Response Body

When isTest = true, the response is a JSON formatted instance for TestResult, as shown below:

Push Data Windows Integrated Authentication - Response Body script.png

Back to top




Master Data Management Service (MDM)

Mutate Entity Schema

Description

Create or update entity schema.

Request

Request Examples

Post/schema/entity/mutateHTTP/1.1
Host: mdm.contoso.com
Content-Length: length

Request URI Parameters

Mutate Entity Schema - Request URI Parameters.png

Request Headers

Mutate Entity Schema - Request Headers.png

Request Body

JSON formatted data for EntitySchemaRequest, as shown below:

Mutate Entity Schema - Request Body script.png

Request Security

Mutate Entity Schema - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK

Response Status Code

Mutate Entity Schema - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Delete Entity Schema

Description

Deletes entity schema.

Request

Request Examples

Get/schema/entity/deleteHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Delete Entity Schema - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Delete Entity Schema - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK

Response Status Code

Delete Entity Schema - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve Entity Schema

Description

Lists all entity schema and their mapping relationships with object schema.

Request

Request Examples

Get/schema/entity/GetHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Entity Schema - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Entity Schema - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

Retrieve Entity Schema - Response Examples script.png

Response Status Code

Retrieve Entity Schema - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for the Entity Schema List, as shown below:

Retrieve Entity Schema - Response Body script.png

Back to top



Retrieve Entity Schema Name When Available

Description

Retrieves entity schema names whenever they are available.

Request

Request Examples

Get/schema/entity/validateHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Entity Schema Name When Available - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Entity Schema Name When Available - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length
true


!!!!Response Status Code
Retrieve Entity Schema Name When Available - Response Status Code.png

Response Headers

N/A

Response Body

A bool value

Back to top



Delete Entity Authorization

Description

Deletes the ACL (all ACEs) of an entity schema.

Request

Request Examples

Get/schema/entity/authorization/deleteHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Delete Entity Authorization - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Delete Entity Authorization - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Delete Entity Authorization - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Mutate Entity Authorization

Description

Creates or updates the ACL (ACEs) of an entity schema.

Request

Request Examples

Post/schema/entity/authorization/mutateHTTP/1.1
Host: mdm.contoso.com
Content-Length: length

Request URI Parameters

Mutate Entity Authorization - Request URI Parameters.png

Request Headers

Mutate Entity Authorization - Request Headers.png

Request Body

JSON formatted data for the List<AceMutation>, as shown below:

Mutate Entity Authorization - Request Body script.png

Request Security

Mutate Entity Authorization - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK

Response Status Code

Mutate Entity Authorization - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Export Schema to EDMX

Description

Retrieves a data model EDMX string from CAM.

Request

Request Examples

Get/schema/datamodel/edmx/exportHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Export Schema to EDMX - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Export Schema to EDMX - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length

Response Status Code

Export Schema to EDMX - Response Status Code.png

Response Headers

N/A

Response Body

EDMX string.

Back to top



Import Schema from EDMX

Description

Transfers EDMX to CAM.

Request

Request Examples

Post/schema/datamodel/edmx/importHTTP/1.1
Host: mdm.contoso.com
Content-Length: length

Request URI Parameters

Import Schema from EDMX - Request URI Parameters.png

Request Headers

Import Schema from EDMX - Request Headers.png

Request Body

EDMX formatted data.

Request Security

Import Schema from EDMX - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK

Response Status Code

Import Schema from EDMX - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Mutate Data Model Authorization

Description

Mutates data model authorization.

Request

Request Examples

Post/schema/datamodel/authorization/mutateHTTP/1.1
Host: mdm.contoso.com
Content-Length: length

Request URI Parameters

Mutate Data Model Authorization - Request URI Parameters.png

Request Headers

Mutate Data Model Authorization - Request Headers.png

Request Body

JSON formatted data for the List<AceMutation>, as shown below:

Mutate Data Model Authorization - Request Body script.png

Request Security

Mutate Data Model Authorization - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK

Response Status Code

Mutate Data Model Authorization - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Delete Data Model Authorization

Description

Deletes data model authorization.

Request

Request Examples

Get/schema/datamodel/authorization/deleteHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Delete Data Model Authorization - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Delete Data Model Authorization - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Delete Data Model Authorization - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve Data Models

Description

Retrieves a list of data models.

Request

Request Examples

Get/schema/datamodel/getHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Data Models - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Data Models - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Retrieve Data Models - Response Examples script.png

Response Status Code

Retrieve Data Models - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for the List<DataModelInfo>.

Back to top



Retrieve HoH Statuses

Description

Retrieves HOH sync statuses for all versions of the data model with the given name.

Request

Request Examples

Get/schema/entity/hoh/status/getHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve HoH Statuses - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve HoH Statuses - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length

Retrieve HoH Statuses - Response Examples script.png

Response Status Code

Retrieve HoH Statuses - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for the List<HoHStatus>.

Back to top



Sync HoH

Description

Sync all versions of the data model with the given name via HBASE or HIVE.

Request

Request Examples

Get/schema/entity/hoh/syncHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Sync HoH - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Sync HoH - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length

Sync HoH - Response Examples script.png

Response Status Code

Sync HoH - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for the List<HoHStatus>.

Back to top



Create Indexes

Description

Creates indexes.

Request

Request Examples

Get/schema/object/index/createHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Create Indexes - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Create Indexes - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Create Indexes - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Dropping Indexes

Description

Dropping an index removes an index or a domain index from the database.

Request

Request Examples

Get/schema/object/index/dropHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Dropping Indexes - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Dropping Indexes - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Dropping Indexes - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve Index Tasks

Description

Retrieves the index tasks.

Request

Request Examples

Get/schema/object/index/task/getHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Index Tasks - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Index Tasks - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length

Retrieve Index Tasks - Response Examples script.png

Response Status Code

Retrieve Index Tasks - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for the List<IndexTask>.

Back to top



Update Index Creation Task

Description

Updates the index creation task.

Request

Request Examples

Get/schema/object/index/task/updateHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Update Index Creation Task - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Update Index Creation Task - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: 0

Response Status Code

Update Index Creation Task - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve Computed Results

Description

Retrieves object through the object schema ID.

Request

Request Examples

Get/schema/object/computeHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Computed Results - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Computed Results - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length

Retrieve Computed Results - Response Examples script.png

Response Status Code

Retrieve Computed Results - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for the List<ComputedObject>, as shown below:

Retrieve Computed Results - Response Body script.png

Back to top



Retrieve Object Schema

Description

Retrieves object schema through object schema identities; identities are split by a comma(,).

Request

Request Examples

Get/schema/object/getHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Object Schema - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Object Schema - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length

Retrieve Object Schema - Response Examples script.png

Response Status Code

Retrieve Object Schema - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for the List<ObjectSchema>.

Back to top



Mutate Computed Attributes

Description

Updates object schema and mutates computed attributes.

Request

Request Examples

Post/schema/object/mutateHTTP/1.1
Host: mdm.contoso.com
Content-Length: length

Request URI Parameters

Mutate Computed Attributes - Request URI Parameters.png

Request Headers

Mutate Computed Attributes - Request Headers.png

Request Body

JSON formatted data for the List<ComputedAttributeMutation>, as shown below:

Mutate Computed Attributes - Request Body script.png

Request Security

Mutate Computed Attributes - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK

Response Status Code

Mutate Computed Attributes - Response Status Code.png

Response Headers

N/A

Response Body

N/A

Back to top



Retrieve Latest Timestamp

Description

Retrieve the latest timestamp. Each request sent to retrieve the latest timestamp will automatically increment the timestamp value by 1. If the timestamp value does not yet exist it is initialized as 1 and will return as 1.

Request

Request Examples

Get/timestampHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

N/A

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Latest Timestamp - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length
Current timestamp in long.

Response Status Code

Retrieve Latest Timestamp - Response Status Code.png

Response Headers

N/A

Response Body

Current timestamp in long.

Back to top



Retrieve Latest Object Timestamp

Description

Retrieves the latest object timestamp.

Request

Request Examples

Get/timestampHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Latest Object Timestamp - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Latest Object Timestamp - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length
Current timestamp in long.

Response Status Code

Retrieve Latest Object Timestamp - Response Status Code.png

Response Headers

N/A

Response Body

Current timestamp in long.

Back to top



Retrieve Latest Object Schema Timestamp

Description

Retrieves the latest object schema timestamp.

Request

Request Examples

Get/timestampHTTP/1.1
Host: mdm.contoso.com
Content-Length: 0

Request URI Parameters

Retrieve Latest Object Schema Timestamp - Request URI Parameters.png

Request Headers

N/A

Request Body

N/A

Request Security

Retrieve Latest Object Schema Timestamp - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Length: length
Current timestamp in long.

Response Status Code

Retrieve Latest Object Schema Timestamp - Response Status Code.png

Response Headers

N/A

Response Body

Current timestamp in long.

Back to top




Blob Service

Download a BLOB

Description

Downloads the binary content of a BLOB from the solution accelerator.

Request

Request Examples

Get/api/blob?id=3F2504E0-4F89-11D3-9A0C-0305E82C3301&entity=testentity&type=application/octet-stream&disposition=attachment;filename=blobHTTP/1.1
Host: blob.contoso.com
Content-Length: 0

Get/api/blob?id=3F2504E0-4F89-11D3-9A0C-0305E82C3301&entity=testentityHTTP/1.1
Host: blob.contoso.com
Content-Type: application/octet-stream
Content-Disposition: attachment;filename=blob
Content-Length: 0

Request URI Parameters

Download a BLOB - Request URI Parameters.png

Request Headers

Download a BLOB - Request Headers.png

Request Body

N/A

Request Security

Download a BLOB - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: attachment;filename=blob
Content-Length: 10

\x00\x11\x22\x33\xAA\xBB\xCC\xDD\xEE\xFF

Response Status Code

Download a BLOB - Response Status Code.png

Response Headers

Download a BLOB - Response Headers.png

Response Body

The binary content for the BLOB, for example:
\x00\x11\x22\x33\xAA\xBB\xCC\xDD\xEE\xFF

Back to top




OData Service

Query Data via OData Protocol

Description

The CityNext OData service has implemented most of the fundamental URI conventions that are specified in OData v3. It is a key service that helps client to query entities stored in the solution accelerator.

Request

Request Examples

GET http://lcd-fe:8001/model/default/v1/rubberduckset HTTP/1.1
User-Agent: Fiddler
Host: lcd-fe:8001

Request URI Parameters

A complete list of URI parameters and conventions are available at OData-V3-URLConvention.
Our implementation supports most of the important query options, as listed below:

Query Data via OData Protocol - Request URI Parameters.png
Query Data via OData Protocol - Request URI Parameters b.png

For the meanings, semantics and usages regarding the URI query options above, please refer to: OData-V3-URLConvention.

Request Headers

N/A

Request Body

N/A

Request Security

Query Data via OData Protocol - Request Security.png

Response

Response Examples

A sample OData response can be viewed in OData-V3-Sample-Products.

Response Status Code

Query Data via OData Protocol - Response Status Code.png

Response Headers

N/A

Response Body

The response body can be either Atom XML or JSON. For more information, please refer to: OData-V3-Atom and OData-V3-JSON.

References

OData-V3-URLConvention: http://www.odata.org/documentation/odata-version-3-0/url-conventions
OData-V3-Sample-Products: http://services.odata.org/V3/OData/OData.svc/Products
OData-V3-Atom: http://www.odata.org/documentation/odata-version-3-0/atom-format/
OData-V3-JSON: http://www.odata.org/documentation/odata-version-3-0/json-verbose-format

Back to top





Data Query Service (DQS)

Retrieve Existing Data Queries

Description

Retrieves existing data queries in the system.

Request

Request Examples

GET http://lcd-fe:8019/query/ HTTP/1.1
Host: lcd-fe:8019

Request URI Parameters

Retrieve Existing Data Queries - Request URI Parameters.png

Request Headers

N/A

Response Body

N/A

Request Security

Retrieve Existing Data Queries - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 2064
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 17 Dec 2014 05:44:03 GMT

{"Pagination":{"PageIndex":0,"PageSize":0,"TotalCount":1},"Timestamp":"\/Date(1418795039546)\/","DataArtifacts":{"CreationTime":"\/Date(347126400000+0800)\/","Description":"Felix Test Data","Id":1,"ModifiedTime":"\/Date(347126400000+0800)\/","Name":"OData_RubberDuck","Publisher":"felixwa","QueryStatement":null,"QueryType":0}}

Response Status Code

Retrieve Existing Data Queries - Response Status Code.png

Response Headers

N/A

Response Body

JSON formatted data for data query entities, as shown below:

{"Pagination":{"PageIndex":0,"PageSize":0,"TotalCount":1},"Timestamp":"\/Date(1418795039546)\/","DataArtifacts":{"CreationTime":"\/Date(347126400000+0800)\/","Description":"Felix Test Data","Id":1,"ModifiedTime":"\/Date(347126400000+0800)\/","Name":"OData_RubberDuck","Publisher":"felixwa","QueryStatement":null,"QueryType":0}}

Retrieve Existing Data Queries - Response Body.png

Back to top



Execute a Data Query

Description

Executes specific data queries and will retrieve query results.

Request

Request Examples

GET http://lcd-fe:8019/query/OData_RubberDuck HTTP/1.1
Host: lcd-fe:8019

Request URI Parameters

Execute a Data Query - Request URI Parameters.png

Request Headers

Execute a Data Query - Request Headers.png

Request Body

N/A

Request Security

Execute a Data Query - Request Security.png

Response

Response Examples

HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 548
Content-Type: application/json
Server: Microsoft-IIS/8.5
X-MS-DQS-QueryIssuedTimestamp: 12/17/2014 7:10:42 AM
X-MS-DQS-ResultTimestamp: 12/17/2014 7:10:48 AM
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 17 Dec 2014 07:10:49 GMT

Execute a Data Query - Response Examples coding script.png

Response Status Code

Execute a Data Query - Response Status Code.png

Response Headers

Execute a Data Query - Response Headers.png

Response Body

When the status code is 200 (OK) the response body content consists of the query execution result (can be empty); either in JSON or CSV format. The response body can be regarded as a data table.

When the status code is 202, the response body may, or may not contain fresh query results. When an old query result is returned, X-MS-DQS-QueryIssuedTimestamp and X-MS-DQS-ResultTimestamp is specified in the header. When X-MS-DQS-ReturnStaleQueryResult:false is specified, the old query result will not be returned.

Other status codes indicate that there is an error and the response body will be empty.

Back to top

Last edited Mar 20, 2015 at 5:05 AM by gheadd, version 30