curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"space": "<string>",
"externalId": "<string>",
"name": "<string>",
"type": "Optimizer",
"source": {
"type": "CogniteFile",
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"configuration": {
"pipelineConfiguration": {
"version": "v1",
"indexingOptions": {
"generateTiles": false,
"tileSize": 5,
"rotationAngleInDegrees": 0,
"useBlackFilter": false,
"useDistanceFilter": false,
"maxDistance": 30,
"useIntensityFilter": false,
"minIntensity": -1,
"useDensityFilter": false,
"filterVoxelSize": 0.01,
"minNumberOfPointsInVoxel": 1,
"densityFilterMethod": 2,
"colorFilterMethod": 1,
"outlierFilterType": 1,
"separationDistance": 5,
"minNumberOfPointsInOneCluster": 100
},
"processTilesOptions": {
"minimumRadius": 0.02,
"classificationMethod": "28class",
"usePipeDetection": true,
"useConfidence": true,
"usePointSources": true,
"saveAnnotations": true
}
}
},
"nonce": "<string>"
}
]
}
'{
"items": [
{
"space": "<string>",
"externalId": "<string>",
"name": "<string>",
"type": "ImageTextDetection",
"source": {
"type": "Cognite360ImageCollection",
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"configuration": {},
"status": "Scheduled",
"createdAt": 123
}
]
}Required capabilities:
datamodels:READ(cdf_cdm, cdf_cdm_3d)datamodelinstances:WRITE
Creates a job to be run using a 3D source. Currently supported in data-modeling projects only. The user defines a dms instance they want the job to run against, and defines it as the source of the job. Inside the job you define the space a job will exist in, and its external id, this is not populated into dms. The job external id should be created by the client, and be unique. If the job result is stored in dms, it will be stored using the space of the job. A session nonce is required by the request.
Job types with supported job sources:
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/3d/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"space": "<string>",
"externalId": "<string>",
"name": "<string>",
"type": "Optimizer",
"source": {
"type": "CogniteFile",
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"configuration": {
"pipelineConfiguration": {
"version": "v1",
"indexingOptions": {
"generateTiles": false,
"tileSize": 5,
"rotationAngleInDegrees": 0,
"useBlackFilter": false,
"useDistanceFilter": false,
"maxDistance": 30,
"useIntensityFilter": false,
"minIntensity": -1,
"useDensityFilter": false,
"filterVoxelSize": 0.01,
"minNumberOfPointsInVoxel": 1,
"densityFilterMethod": 2,
"colorFilterMethod": 1,
"outlierFilterType": 1,
"separationDistance": 5,
"minNumberOfPointsInOneCluster": 100
},
"processTilesOptions": {
"minimumRadius": 0.02,
"classificationMethod": "28class",
"usePipeDetection": true,
"useConfidence": true,
"usePointSources": true,
"saveAnnotations": true
}
}
},
"nonce": "<string>"
}
]
}
'{
"items": [
{
"space": "<string>",
"externalId": "<string>",
"name": "<string>",
"type": "ImageTextDetection",
"source": {
"type": "Cognite360ImageCollection",
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
},
"configuration": {},
"status": "Scheduled",
"createdAt": 123
}
]
}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.
The job with a given source. Currently supports only one job to be created at the time.
1 elementShow child attributes
A list of the created jobs
Show child attributes
Was this page helpful?