Getting the Details of a Flow

Usage

Gets the details on the data provider flow specified in XML or CSV format.

Request

GET /documents/<documentID>/dataproviders/<dataProviderID>/flows<flowID>

Response

Response type: text/xml or text/plain

Response body: for one data provider, it retrieves the flow details.

  • In XML format, the index cells and their values by row.
  • In CSV format, values only.

Example

Plain Text

This example retrieves the first flow (flowId is 0) of the data provider DP0 available for the document ID 7744.

GET /documents/7744/dataproviders/DP0/flows/0

Response (CSV format):

"Year";"State";"Sales revenue";"Margin"
"2001";"California";"1704210.8";"774893.4"
"2001";"Colorado";"448301.5";"203700.6"
"2001";"DC";"693210.5";"310356.2"
"2001";"Florida";"405985.1";"192479.3"
"2001";"Illinois";"737914.2";"348749.8"
"2002";"California";"2782679.5";"1076528"
"2002";"Colorado";"768389.5";"294482.6"
"2002";"DC";"1215158";"457230.6"
"2003";"California";"2992679";"1121488.5"
...

Example

XML Format

This example retrieves the first flow (flowId is 0) of the data provider DP0 available for the document ID 12575.

GET /documents/12575/dataproviders/DP0/flows/0

<DATA_PROVIDERS>
    <DATA_PROVIDER>
        <ROW>
            <CELL INDEX="0">2006</CELL>
            <CELL INDEX="1">12</CELL>
            <CELL INDEX="2">Texas </CELL>
            <CELL INDEX="3">Dallas</CELL>
            <CELL INDEX="4">e-Fashion Dallas</CELL>
            <CELL INDEX="5">43302.1</CELL>
            <CELL INDEX="6">222</CELL>
            <CELL INDEX="7">17829.4</CELL>
        </ROW>
        <ROW>
            <CELL INDEX="0">2006</CELL>
            <CELL INDEX="1">12</CELL>
            <CELL INDEX="2">Texas </CELL>
            <CELL INDEX="3">Houston</CELL>
            <CELL INDEX="4">e-Fashion Houston</CELL>
            <CELL INDEX="5">55454.6</CELL>
            <CELL INDEX="6">258</CELL>
            <CELL INDEX="7">24614.6</CELL>
        </ROW>
        <ROW>
            <CELL INDEX="0">2006</CELL>
            <CELL INDEX="1">12</CELL>
            <CELL INDEX="2">Texas </CELL>
            <CELL INDEX="3">Houston</CELL>
            <CELL INDEX="4">e-Fashion Houston Leighton</CELL>
            <CELL INDEX="5">77237.7</CELL>
            <CELL INDEX="6">366</CELL>
            <CELL INDEX="7">34926.7</CELL>
        </ROW>
    </DATA_PROVIDER>
</DATA_PROVIDERS>