UnifiedViews - Pipelines Services

This section contains all API calls you can use to create and edit pipelines and request pipelines' information.

Find the following topics in this section:

UnifiedViews Method - Create Pipeline

Description

Use this call to create a UnifiedViews pipeline.

URL: http://{server}/master/api/1/pipelines

Content Type

application/json

Request

Supported Method

POST

HTTP Parameters

Parameter

Type

Required

Description

name

string

true

Name of your choice for the pipeline you want to create.

description

string

false

A description for the pipeline details.

Example Request
{
    "name": "Extract data from DBpedia",
    "description": "This pipeline uses SPARQL Endpoint extractor to fetch information about cities from DBpedia"
}
ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes
  • id (mandatory): ID of the requested pipeline

  • name (optional): name of the requested pipeline

  • description (optional): description of the requested pipeline

Example Response
{ 
  id: 1,
  name: "The pipeline",
  description: "The description"
}

UnifiedViews Method - Copy Pipeline

Description

This call lets you copy an existing pipeline.

URL: http://{server}/master/api/1/pipelines/{pipeline_id}/clone?

Content Type

application/json

Request

Supported Method

POST

HTTP Parameters

Parameter

Type

Required

Description

name

string

true

Name of the pipeline you want to copy.

description

string

false

A description for the pipeline details the copy should contain.

owner

string

false

Owner of the pipeline.

Note

You can use these API calls to request one or all existing pipelines and their information:

Example Request
curl --location --request POST "http://{{server}}/master/api/1/pipelines/{{pipelineId}}/clone" \
  --header "Content-Type: application/json" \
  --data "{
    \"name\": \"Extract data from DBpedia - Copy\",
    \"description\": \"This is a Copy of the pipeline, which uses SPARQL Endpoint extractor to fetch information about cities from DBpedia\",
    \"owner\": \"user\"
}"
ResponseContent-Type

application/json

Status: 200 - OK

Example Response
{ 
  id: 1,
  name: "The pipeline",
  description: "The description"
}

UnifiedViews Method - Import Pipeline

Description

This API call lets you import a pipeline.

URL: http://{server}/master/api/1/pipelines/import

Note

The idea behind implementing a pipeline import is to enable automatic testing and deployment.

Content Type

multipart/form-data

Request

Supported Method

POST

HTTP Parameters

Parameter

Type

Required

Description

file

true

ZIP file with pipeline to import.

asUser

string

true

User who is marked as pipeline author.

importUserData

string

false

Indicates if user data should be imported.

Allowed values: true/false

importSchedule

boolean

false

Defines if an existing schedule for that pipeline should be imported.

userExternalId

string

false

Indicates if schedule information should be imported.

Allowed values: true/false

Example Request
Content-Disposition:form-data; name="file"; filename="zipperPipeline.zip"
 
Content-Disposition:form-data; name="importUserData"
true
 
Content-Disposition: form-data; name="importSchedule"
true
  
Content-Disposition: form-data; name="asUser"
admin
ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes

Attribute

Type

Required

Description

id

number

true

The ID of the imported pipeline in this UV instance.

name

string

true

Name of the pipeline.

asUser

string

true

User who is marked as pipeline author.

userActorExternalId

string

false

Indicates if additional users have permission to edit or execute this pipeline.

Possible values: 'null' or an existing username.

Example Response
{
    "id": 60,
    "name": "The pipeline",
    "description": "The description",
    "asUser": "admin",
    "userActorExternalId": null
}

UnifiedViews Method - Request One Pipeline

Description

Request the information about the specified pipeline.

URL: http://{server}/master/api/1/pipelines/{id}

Content Type

application/json

Request

Supported Method

GET

HTTP Parameters

Parameter

Type

Required

Description

id

number

true

ID of the pipeline to return information about.

asUser

string

true

User with permission to view and edit this pipeline.

name

string

true

Name of your choice for the pipeline you want to create.

description

string

false

A description for the pipeline details.

Example Request
http://admin:commander@localhost:8080/master/api/1/pipelines/33?asUser=admin
ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes

Attribute

Type

Required

Description

id

number

true

ID of the pipeline.

name

string

true

Name of your choice for the pipeline you want to create.

description

string

false

A description for the pipeline details.

Example Response
{ 
  id: 1,
  name: "The pipeline",
  description: "The description"
}

UnifiedViews Method - Request All Pipelines

Description

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

URL: http://{server}/master/api/1/pipelines

Content Type

application/json

Request

Supported Method

GET

HTTP Parameter

Parameter

Type

Required

Description

asUser

string

false

Username of the user who owns the pipelines to be requested.

Example Request
curl http://master:commander@localhost:8080/master/api/1/pipelines?
Example Request including Owner's Name
curl http://master:commander@localhost:8080/master/api/1/pipelines?asUser=user
ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes

Attributes

Type

Required

Description

id

Object

true

ID object of the pipeline

localName

string

true

ID of the pipeline

namespace

string

true

Resource path of the pipeline

name

string

true

Name of the pipeline

username

string

true

User who is marked as pipeline author.

userActorExternalId

'null' or string

false

User who has permission to view the pipeline.

Example Response
[
    {
        "id": {
            "localName": "87b3b364-2594-40a1-b49d-d4d1149f567c",
            "namespace": "http://unifiedviews.poolparty.biz/resource/pipeline/"
        },
        "name": "AD-4 v.2",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis pulvinar turpis id vulputate congue. Donec eleifend nunc et sagittis porta. Praesent odio sem, dapibus tempus dui et, tempus condimentum tortor. Integer non hendrerit leo.   \n",
        "username": "admin",
        "userActorExternalId": null
    },
    {
        "id": {
            "localName": "873cddae-51d1-4f20-8428-e1200d7c4f88",
            "namespace": "http://unifiedviews.poolparty.biz/resource/pipeline/"
        },
        "name": "AD-4 v.3",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis pulvinar turpis id vulputate congue. Donec eleifend nunc et sagittis porta. Praesent odio sem, dapibus tempus dui et, tempus condimentum tortor. Integer non hendrerit leo.  \n",
        "username": "admin",
        "userActorExternalId": null
    },
    {
        "id": {
            "localName": "a0b681d6-8408-4ac2-ba5b-6e3e6caf1ed2",
            "namespace": "http://unifiedviews.poolparty.biz/resource/pipeline/"
        },
        "name": "AD-4",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis pulvinar turpis id vulputate congue. Donec eleifend nunc et sagittis porta. Praesent odio sem, dapibus tempus dui et, tempus condimentum tortor. Integer non hendrerit leo.  \n",
        "username": "admin",
        "userActorExternalId": null
    }
]

UnifiedViews Method - Request All Visible Pipelines

Description

This call returns a list of all pipelines visible for the user specified.

URL: http://{server}/master/api/1/pipelines/visible?asUser=admin

Note

Visible pipelines of a user are those he is owner of as well as the public pipelines of others.

Content Type

application/json

Request

Supported Method

GET

HTTP Parameters

Parameter

Type

Required

Description

asUser

string

true

User who is marked as pipeline author.

ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes

Attributes

Type

Required

Description

id

Object

true

ID object of the pipeline

localName

string

true

ID of the pipeline

namespace

string

true

Resource path of the pipeline

name

string

true

Name of the pipeline

username

string

true

User who is marked as pipeline author.

userActorExternalId

'null' or string

false

User who has permission to view the pipeline.

Example Response
[
    {
        "id": {
            "localName": "87b3b364-2594-40a1-b49d-d4d1149f567c",
            "namespace": "http://unifiedviews.poolparty.biz/resource/pipeline/"
        },
        "name": "AD-4 v.2",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis pulvinar turpis id vulputate congue. Donec eleifend nunc et sagittis porta. Praesent odio sem, dapibus tempus dui et, tempus condimentum tortor. Integer non hendrerit leo.   \n",
        "username": "admin",
        "userActorExternalId": null
    },
    {
        "id": {
            "localName": "873cddae-51d1-4f20-8428-e1200d7c4f88",
            "namespace": "http://unifiedviews.poolparty.biz/resource/pipeline/"
        },
        "name": "AD-4 v.3",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis pulvinar turpis id vulputate congue. Donec eleifend nunc et sagittis porta. Praesent odio sem, dapibus tempus dui et, tempus condimentum tortor. Integer non hendrerit leo.  \n",
        "username": "admin",
        "userActorExternalId": null
    },
    {
        "id": {
            "localName": "a0b681d6-8408-4ac2-ba5b-6e3e6caf1ed2",
            "namespace": "http://unifiedviews.poolparty.biz/resource/pipeline/"
        },
        "name": "AD-4",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis pulvinar turpis id vulputate congue. Donec eleifend nunc et sagittis porta. Praesent odio sem, dapibus tempus dui et, tempus condimentum tortor. Integer non hendrerit leo.  \n",
        "username": "admin",
        "userActorExternalId": null
    }
]

UnifiedViews Method - Delete Pipeline

Description

Use this call to delete a UnifiedViews pipeline.

URL: http://{server}/master/api/1/pipelines/{pipelineId}?deleteScheduled=true

Content Type

application/json

Request

Supported Method

DELETE

HTTP Parameters

Parameter

Type

Required

Description

deleteScheduled

boolean

false

This value lets you also delete pipelines whose execution has been scheduled.

Default value: false

Example Request
curl --location --request DELETE "http://{{server}}/master/api/1/pipelines/{{pipelineId}}?deleteScheduled=true"
ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes
  • id (mandatory): ID of the requested pipeline

  • name (optional): name of the requested pipeline

  • description (optional): description of the requested pipeline

Example Response
{