Jump to

• Request
• Response

Retrieve Integration Activation Errors in a Project

get

/ic/api/integration/v1/projects/{projectId}/integrations/{id}/activationErrors

Retrieves integration activation errors for the specified integration ID within a project.

Request

Path Parameters

• id(required): string
  Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.
• projectId(required): string
  Project identifier

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : IntegrationActivationErrorRs

Type: object

Show Source

• code: string
  Integration Code
• errorMessage: string
  Integration Activation Error Message
• hasErrors: boolean
  Flag to Check if Error Exists
• shortSummaryMessage: string
  Short Summary Message
• version: string
  Integration Version

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Integration Code"
        },
        "hasErrors":{
            "type":"boolean",
            "description":"Flag to Check if Error Exists"
        },
        "errorMessage":{
            "type":"string",
            "description":"Integration Activation Error Message"
        },
        "version":{
            "type":"string",
            "description":"Integration Version"
        },
        "shortSummaryMessage":{
            "type":"string",
            "description":"Short Summary Message"
        }
    }
}

404 Response

Integration not found

412 Response

Precondition failed

500 Response

Server error

Back to Top