Report Extractor Info

Required capabilities: integrationsAcl:USE

Report changes to general information about the extractor, and indicates to the API that the extractor has started. This will close any currently running tasks with an error.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Update to extractor information.

externalId
required
string (IntegrationsExternalId) [ 1 .. 255 ] characters

The external ID provided by the client. Must be unique for the resource type.

required
object (IntegrationExtractor)

Identifier for an extractor. Note that if the extractor externalId starts with cognite, it must correspond to a cognite extractor.

Array of objects (Task)

A list of tasks configured for this extractor.

Revision (integer) or string

The currently active config revision, or "local" if a local config file is in use.

timestamp
integer (Timestamp)

Timestamp of the startup event in milliseconds since 01/01/1970.

Responses
200

Response with updates for the extractor.

400

Response for a failed request

422

Request validation failed.

post/integrations/startup
Request samples
application/json
{
  • "externalId": "my.integrations.id",
  • "extractor": {
    • "externalId": "cognite-opcua",
    • "version": "1.2.3"
    },
  • "tasks": [
    • {
      }
    ],
  • "activeConfigRevision": 0,
  • "timestamp": 0
}
Response samples
application/json
{
  • "externalId": "my.integrations.id",
  • "lastConfigRevision": 0
}
➔ Next to Retrieve Integrations