Data Pipeline
Get Data Pipeline
Endpoint to retrieve a single Data Pipeline by ID
post/data-pipeline/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Data Pipeline to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"lastRunId": true,
"lastRunState": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"jobNamespace": "This is an example of longer text content that might be stored in this field.",
"jobName": "This is an example of longer text content that might be stored in this field.",
"pipelineKey": "This is an example of longer text content that might be stored in this field.",
"description": "# Heading\n\nThis is **markdown** content",
"lastRunId": "Example short text",
"lastRunState": "Example short text",
"lastRunStartedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastRunEndedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastRunDurationInSeconds": 42,
"lastSuccessAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastFailureAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastErrorMessage": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"runCount": 42,
"typicalRunDurationInSeconds": 42,
"expectedRunIntervalInSeconds": 42,
"inputs": {
"key": "value",
"nested": {
"data": 123
}
},
"outputs": {
"key": "value",
"nested": {
"data": 123
}
},
"firstSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.