Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

1. Pipelines

1.1 Get all Pipelines

Returns list of all pipelines for the given user (user is owner of those pipelines).

Request

Code Block
GET <prefix>/pipelines
Accept: application/json

...

Code Block
HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": 98,
    "name": "[AutoTest] RDF from file - Merge RDF - Validate RDF - RDF to CKAN",
    "description": "",
    "userExternalId": "4AFA411A-476B-4B49-8F48-3274B838F460",
    "userActorExternalId": "8EEBA23B-6BFE-4F76-A3B5-D9B627823137"
  },
  {
    "id": 24,
    "name": "Periodické sťahovanie meteo dát",
    "description": "",
    "userExternalId": "4AFA411A-476B-4B49-8F48-3274B838F460",
    "userActorExternalId": null
  },
  {
    "id": 20,
    "name": "Priebežná aktualizácia dátového zdroja (MV)",
    "description": "",
    "userExternalId": "4AFA411A-476B-4B49-8F48-3274B838F460",
    "userActorExternalId": null
  }
]

Returns list of all pipelines. 

Response, error

Code Block
HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "errorMessage": "user readable message",
  "technicalMessage": "some technical message"
}

...

1.3 Get all visible Pipelines

Returns list of all pipelines visible for the user specified in parameter userExternalId. This means pipelines of that user (he is owner) and public pipelines of others 

Request

Code Block
GET <prefix>/pipelines/visible?userExternalId=admin
Accept: application/json

...

Code Block
HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "errorMessage": "user readable message",
  "technicalMessage": "some technical message"
}
scheduledexecutions

1.4 Create Pipeline

Request

...

2.1 Get all Pipeline.Schedules events

Get all scheduled events for the given pipeline id 

Request

Code Block
GET <prefix>/pipelines/<pipeline_id>/schedules/
Accept: application/json

...

2.2 Get one Pipeline.Schedule event

Get one scheduled events (with the given id) for the given pipeline id 

Request

Code Block
GET <prefix>/pipelines/<pipeline_id>/schedules/<id>
Accept: application/json

...

5.1 Get next Pipeline.Schedule.ScheduledExecution

For the given pipeline, get next scheduled executions

Request

Code Block
GET <prefix>/pipelines/<pipeline_id>/schedules/~all/scheduledexecutions
Accept: application/json

...