Activate a project - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Stages and optionally activates a project, with optional pipeline start.

HTML

POST https://hostname/v1/integration/continuous/projects/{projectId}/activation

Process overview

  1. Based on the ProjectActivationRequest, this endpoint triggers the appropriate operations.
  2. If stage is true, the project configurations are staged, and the user is redirected to the staging status endpoint.
  3. If activate is true, the project is activated, and the user is redirected to the alerts endpoint.
  4. If startPipelines is true, the pipelines associated with the project are started.

Redirect details

  • When stage is true, the Location header in the response contains the URI to monitor the staging status of the project.
  • When activate is true, the Location header in the response contains the URI to the project's alerts endpoint.
  • Clients can use the Location header to navigate to the appropriate endpoint for further actions.

Key features

  • Allows users to manage the lifecycle of a project (staging, activation, pipeline starting).
  • Provides redirection to relevant endpoints based on the operation performed.
  • Ensures that the operations are performed asynchronously where applicable.

Required permissions

replication-pipeline::manage

Request

Path parameters

Key Required Type Description
projectId Yes string

The unique identifier of the project to activate.

Request body properties

Ancestors Property Required Type Description
  stage Yes boolean

Flag to indicate whether the project should be staged.
  stagingOptions No object

Options for staging the project.
stagingOptions validate No boolean

Flag to indicate whether staging configuration should be validated.
stagingOptions type No object Options for staging the project.
stagingOptions activate Yes boolean

Flag to indicate whether staging configuration should be validated.
  activationOptions No object

Options for activating the project.
activationOptions forced No boolean

Flag to indicate whether activation should be forced, overriding any existing active configurations.
activationOptions queueTimeoutInMinutes No integer

Queue timeout in minutes.
activationOptions stopRequestTimeoutInMinutes No integer

Stop request timeout in minutes.
activationOptions tableCaptureTimeoutInMinutes No integer

Table capture timeout in minutes.
  startPipelines Yes boolean

Flag to indicate whether pipelines within the project should be started.

Request body example

{
  "stage": true,
  "stagingOptions": {
    "validate": true,
    "type": "INCREMENTAL_COMMIT"
  },
  "activate": true,
  "activationOptions": {
    "forced": false,
    "queueTimeoutInMinutes": 4,
    "stopRequestTimeoutInMinutes": 4,
    "tableCaptureTimeoutInMinutes": 8
  },
  "startPipelines": true
}

Response

Header keys

Key Required Type Description
Location No string

URI to monitor the activation or staging status.

Example: /projects/project-123/staging/status

Response examples

{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "Validation error occurred",
  "instance": "/v1/integration/continuous/projects/{projectId}/activation",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0000"
  }
}
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authorization failed - missing or invalid credentials",
  "instance": "/v1/integration/continuous/projects/{projectId}/activation",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0001"
  }
}
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authorization failed - missing or invalid credentials",
  "instance": "/v1/integration/continuous/projects/{projectId}/activation",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0001"
  }
}
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "instance": "/v1/integration/continuous/projects/{projectId}/activation",
  "properties": {
    "errorCode": "DI-ADAPTER-ACT-0006"
  }
}