New: build custom CDF applications with Cognite Flows. Documentation · What's new.
res = client.extraction_pipelines.retrieve(id=1)
res = client.extraction_pipelines.retrieve(external_id="1"){
"externalId": "<string>",
"name": "<string>",
"dataSetId": 4503599627370495,
"description": "<string>",
"rawTables": [
{
"dbName": "<string>",
"tableName": "<string>"
}
],
"schedule": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"role": "<string>",
"sendNotification": true
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"source": "<string>",
"documentation": "<string>",
"notificationConfig": {
"allowedNotSeenRangeInMinutes": 1
},
"createdBy": "<string>",
"id": 4503599627370495,
"lastSuccess": 123,
"lastFailure": 123,
"lastMessage": "<string>",
"lastSeen": 123,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}Retrieve an extraction pipeline by its ID.
Required capabilities:
extractionpipelinesAcl:READ
Retrieve an extraction pipeline by its ID. If you want to retrieve extraction pipelines by externalIds, use Retrieve extraction pipelines instead.
res = client.extraction_pipelines.retrieve(id=1)
res = client.extraction_pipelines.retrieve(external_id="1"){
"externalId": "<string>",
"name": "<string>",
"dataSetId": 4503599627370495,
"description": "<string>",
"rawTables": [
{
"dbName": "<string>",
"tableName": "<string>"
}
],
"schedule": "<string>",
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"role": "<string>",
"sendNotification": true
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"source": "<string>",
"documentation": "<string>",
"notificationConfig": {
"allowedNotSeenRangeInMinutes": 1
},
"createdBy": "<string>",
"id": 4503599627370495,
"lastSuccess": 123,
"lastFailure": 123,
"lastMessage": "<string>",
"lastSeen": 123,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
A server-generated ID for the object.
1 <= x <= 9007199254740991Response
Single extraction pipeline response
External Id provided by client. Should be unique within the project.
1 - 255Name of Extraction Pipeline
1 - 140DataSet ID
0 <= x <= 9007199254740991Description of Extraction Pipeline
500Raw tables
Show child attributes
Show child attributes
Possible values: “On trigger”, “Continuous” or cron expression. If empty then null
^(On trigger|Continuous)|(@(annually|yearly|monthly|weekly|daily|hourly|reboot))|(@every (\d+(ns|us|µs|ms|s|m|h))+)|((((\d+,)+\d+|(\d+([/\-])\d+)|\d+|\*(/\d+)?) ?){5,7})$Contacts list.
Show child attributes
Show child attributes
Custom, application specific metadata. String key -> String value. Limits: Key are at most 128 bytes. Values are at most 10240 bytes. Up to 256 key-value pairs. Total size is at most 10240.
Show child attributes
Show child attributes
{
"property1": "string",
"property2": "string"
}Source for Extraction Pipeline
255Documentation text field, supports Markdown for text formatting.
10000Show child attributes
Show child attributes
Extraction Pipeline creator. Usually user email is expected here
255A server-generated ID for the object.
0 <= x <= 9007199254740991Time of last successful run. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
Time of last failure run. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
Last failure message.
Last seen time. The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Was this page helpful?