Skip to content

Latest commit

 

History

History
169 lines (155 loc) · 4.41 KB

foundry-api-status-information-1.md

File metadata and controls

169 lines (155 loc) · 4.41 KB
description
Describes the APIs for checking the source's status

Foundry API: Status Information

{% swagger baseUrl="https://foundry-dev.scicrunch.io" path="/foundry/api/dashboard/status" method="get" summary="dashboard/status" %} {% swagger-description %} Gives the status of a single source {% endswagger-description %}

{% swagger-parameter in="query" name="apiKey" type="string" %} Authentication Token {% endswagger-parameter %}

{% swagger-parameter in="query" name="sourceID" type="string" %} Source to be ingested {% endswagger-parameter %}

{% swagger-response status="200" description="" %}

{
  "sourceID": "SCR_013869-Cellosaurus-RIN",
  "dataSource": "SCR_013869-Cellosaurus-RIN",
  "startDate": "2019-12-17T15:53:59.000-08:00",
  "endDate": "2019-12-17T16:50:44.000-08:00",
  "ingestionEndDate": "2019-12-17T15:54:14.000-08:00",
  "new": 0,
  "resource.enhanced.1": 95,
  "ingested": 0,
  "finished": 95,
  "error": 0,
  "transformed.1": 95,
  "runStats": {
    "resourceID": "SCR_013869-Cellosaurus-RIN",
    "dataSource": "SCR_013869-Cellosaurus-RIN",
    "startDate": "Tue Dec 17 16:49:34 PST 2019",
    "endDate": "Tue Dec 17 16:50:44 PST 2019",
    "newCount": 95,
    "sameCount": 0,
    "changeCount": 5,
    "errorCount": 0,
    "finished": true,
    "opType": "partial__transform__to_end"
  }
}

{% endswagger-response %}

{% swagger-response status="400" description="" %}

{% endswagger-response %}

{% swagger-response status="403" description="" %}

{% endswagger-response %}

{% swagger-response status="404" description="" %}

{% endswagger-response %}

{% swagger-response status="500" description="" %}

{% endswagger-response %} {% endswagger %}

{% swagger baseUrl="https://foundry-dev.scicrunch.io" path="/foundry/api/dashboard/status/all" method="get" summary="dashboard/status/all" %} {% swagger-description %} Gives the status of all the sources {% endswagger-description %}

{% swagger-parameter in="query" name="apiKey" type="string" %} Authentication Token {% endswagger-parameter %}

{% swagger-response status="200" description="A JSON array of JSON objects, one per source" %}

[
  {
    "sourceID": "SCR_013869-Cellosaurus-RIN",
    "dataSource": "SCR_013869-Cellosaurus-RIN",
    "startDate": "2019-12-17T15:53:59.000-08:00",
    "endDate": "2019-12-17T16:50:44.000-08:00",
    "ingestionEndDate": "2019-12-17T15:54:14.000-08:00",
    "new": 0,
    "resource.enhanced.1": 95,
    "ingested": 0,
    "finished": 95,
    "error": 0,
    "transformed.1": 95,
    "runStats": {
      "resourceID": "SCR_013869-Cellosaurus-RIN",
      "dataSource": "SCR_013869-Cellosaurus-RIN",
      "startDate": "Tue Dec 17 16:49:34 PST 2019",
      "endDate": "Tue Dec 17 16:50:44 PST 2019",
      "newCount": 95,
      "sameCount": 0,
      "changeCount": 5,
      "errorCount": 0,
      "finished": true,
      "opType": "partial__transform__to_end"
    }
  },
  {
    "sourceID": "SCR_013869-Cellosaurus-RIN-test",
    "dataSource": "SCR_013869-Cellosaurus-RIN-test",
    "startDate": "2019-07-17T13:53:41.000-07:00",
    "endDate": "",
    "ingestionEndDate": "2019-07-17T13:53:43.000-07:00",
    "new": 0,
    "resource.enhanced.1": 0,
    "ingested": 10,
    "finished": 0,
    "error": 10,
    "transformed.1": 0,
    "runStats": {
      "resourceID": "SCR_013869-Cellosaurus-RIN-test",
      "dataSource": "SCR_013869-Cellosaurus-RIN-test",
      "startDate": "Wed Jul 17 13:53:41 PDT 2019",
      "newCount": 100,
      "sameCount": 90,
      "changeCount": 10,
      "errorCount": 0,
      "finished": false,
      "opType": "full"
    }
  },
  {
    "sourceID": "SCR_017612-EBRAINS_KG-KS",
    "dataSource": "SCR_017612-EBRAINS_KG-KS",
    "startDate": "2019-12-11T13:44:34.000-08:00",
    "endDate": "",
    "ingestionEndDate": "2019-12-11T13:44:38.000-08:00",
    "new": 0,
    "resource.enhanced.1": 10,
    "ingested": 26,
    "finished": 3,
    "error": 0,
    "transformed.1": 16,
    "runStats": {
      "resourceID": "SCR_017612-EBRAINS_KG-KS",
      "dataSource": "SCR_017612-EBRAINS_KG-KS",
      "startDate": "Wed Dec 11 13:44:34 PST 2019",
      "newCount": 0,
      "sameCount": 545,
      "changeCount": 26,
      "errorCount": 0,
      "finished": false,
      "opType": "full"
    }
  }
]

{% endswagger-response %}

{% swagger-response status="403" description="" %}

{% endswagger-response %}

{% swagger-response status="500" description="" %}

{% endswagger-response %} {% endswagger %}