Create Integration Service

POST 
/organizations/:organizationId/integrations

Create Integration Service

Request

Path Parameters

organizationId stringrequired

The ID of organization.

application/json

Body

required

name stringrequired

The name of integration.

description string

The description of integration.

type stringrequired

The type of integration.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the services.
id stringrequired
organizationId stringrequired
name stringrequired
description stringrequired
type stringrequired
config objectrequired
host stringrequired
apiKey stringrequired
authorization stringrequired
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "organizationId": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "config": {
      "host": "string",
      "apiKey": "string",
      "authorization": "string"
    },
    "createdBy": "string",
    "createdAtDateString": "string",
    "createdAt": 0
  }
}

Example

{
  "id": "is-integrationServiceId",
  "organizationId": "o-organizationId",
  "name": "LNS-Service",
  "description": "LNS-Service-Description",
  "type": "InfodeckLNS",
  "config": {
    "host": "lns-hosto:8080",
    "apiKey": "eyJ0exxxxxxxxxx4",
    "authorization": "eyJhbxxxxxxxxxxg"
  },
  "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
  "createdAtDateString": "2024-01-01T00:00:00.000Z",
  "createdAt": 1704067200000
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...