API reference (20230101-alpha)
from cognite.client.data_classes import ExtractionPipelineRunWrite
res = client.extraction_pipelines.runs.create(
ExtractionPipelineRunWrite(status="success", extpipe_external_id="extId")){
"items": [
{
"status": "<string>",
"id": 4503599627370496,
"message": "<string>",
"createdTime": 1730204346000,
"externalId": "<string>"
}
]
}Create extraction pipeline runs
Required capabilities:
extractionrunsAcl:WRITEdatasetsAcl:READ
Create multiple extraction pipeline runs. Current version supports one extraction pipeline run per request. Extraction pipeline runs support three statuses: success, failure, seen. The content of the Error Message parameter is configurable and will contain any messages that have been configured within the extraction pipeline.
from cognite.client.data_classes import ExtractionPipelineRunWrite
res = client.extraction_pipelines.runs.create(
ExtractionPipelineRunWrite(status="success", extpipe_external_id="extId")){
"items": [
{
"status": "<string>",
"id": 4503599627370496,
"message": "<string>",
"createdTime": 1730204346000,
"externalId": "<string>"
}
]
}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.
Body
1 - 1000 elementsShow child attributes
Show child attributes
Response
Response with list of extraction pipeline runs
Show child attributes
Show child attributes
Was this page helpful?