Constructing a Request
A request to the Pipeline API takes the form:
{HTTP Method} {Base URL}/{path} {Resource} {Credentials} {optional message body}
Where:
- Base URL – platform uses a fixed base URL that is:
- Path –
/pipeline-service/v2/
- Resource – For more information, see the Pipeline API Reference.
- Credentials – For more information, see the Identity & Access Management Guide.
Example
Create a Pipeline object using curl:
curl -X POST "https://pipelines.api.platform.hereolp.cn/pipeline-service/v2/pipelines"
-H "accept: application/json"
-H "Content-Type: application/json"
-d "{
\"name\": \"Weather Data Analysis for Predictive Traction Control\",
\"type\": \"STREAMING\",
\"framework\": \"FLINK\",
\"description\": \"Weather analysis per region processed to adjust tire traction in real time.\",
\"groupId\": \"GROUP-563e9cea-2876-4458-926f-6cad83b64f45\"
}"
POST
is the request method specified for theCreate a Pipeline
call in the API reference.- The
Create a Pipeline
call is specified by/v2/pipelines
as noted in the API reference. - The endpoint becomes
.
- The rest of the call string is determined by the pipeline specification to create the pipeline (as defined by the Pipeline Service API request-model).
Caution
To make string concatenation easy, API base URLs do not end with a '/' character.