GET v1/Results/{id}

Gets the results of job that was executed by the Run ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Run ID of the job to cancel.

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of resultsResponse
NameDescriptionTypeAdditional information
runID

GUID-formatted ID which was supplied by the user at the start

string

None.

startTime

date

None.

runTime

How long the job took to run.

string

None.

status

Result status after run. Typically "Complete" or "Failed".

string

None.

totalRows

Total number of Origin rows processed.

integer

None.

inserts

Number of rows inserted in the Destination.

integer

None.

updates

Number of rows updated in the Destination.

integer

None.

deletes

Number of rows deleted in the Destination.

integer

None.

errors

Number of errors that occurred.

integer

None.

skips

Number of rows skipped (for instance by calling GotoNextRow or using SkipIfBlank).

integer

None.

ignores

Number of ignored rows (occurs when an update operation is attempted, but there are no matching records to update)

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "runID": "sample string 1",
    "startTime": "2019-07-20T02:43:56.2382987-05:00",
    "runTime": "sample string 3",
    "status": "sample string 4",
    "totalRows": 5,
    "inserts": 6,
    "updates": 7,
    "deletes": 8,
    "errors": 9,
    "skips": 10,
    "ignores": 11
  },
  {
    "runID": "sample string 1",
    "startTime": "2019-07-20T02:43:56.2382987-05:00",
    "runTime": "sample string 3",
    "status": "sample string 4",
    "totalRows": 5,
    "inserts": 6,
    "updates": 7,
    "deletes": 8,
    "errors": 9,
    "skips": 10,
    "ignores": 11
  }
]

application/xml, text/xml

Sample:
<ArrayOfresultsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StarfishAPI.Controllers">
  <resultsResponse>
    <deletes>8</deletes>
    <errors>9</errors>
    <ignores>11</ignores>
    <inserts>6</inserts>
    <runID>sample string 1</runID>
    <runTime>sample string 3</runTime>
    <skips>10</skips>
    <startTime>2019-07-20T02:43:56.2382987-05:00</startTime>
    <status>sample string 4</status>
    <totalRows>5</totalRows>
    <updates>7</updates>
  </resultsResponse>
  <resultsResponse>
    <deletes>8</deletes>
    <errors>9</errors>
    <ignores>11</ignores>
    <inserts>6</inserts>
    <runID>sample string 1</runID>
    <runTime>sample string 3</runTime>
    <skips>10</skips>
    <startTime>2019-07-20T02:43:56.2382987-05:00</startTime>
    <status>sample string 4</status>
    <totalRows>5</totalRows>
    <updates>7</updates>
  </resultsResponse>
</ArrayOfresultsResponse>