List Integration Services

GET 
/organizations/:organizationId/integrations

List Integration Services

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

maxResults number

Possible values: >= 10 and <= 100

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Array of integration services.
Array [
id stringrequired
organizationId stringrequired
name stringrequired
description stringrequired
type stringrequired
config objectrequired
host stringrequired
apiKey stringrequired
authorization stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "description": "string",
      "type": "string",
      "config": {
        "host": "string",
        "apiKey": "string",
        "authorization": "string"
      },
      "createdAtDateString": "string",
      "createdAt": 0,
      "updatedAtDateString": "string",
      "updatedAt": 0
    }
  ]
}

Example

{
  "data": [
    {
      "id": "is-integrationServiceId",
      "organizationId": "o-organizationId",
      "name": "LNS-Service",
      "description": "LNS-Service-Description",
      "type": "InfodeckLNS",
      "config": {
        "host": "lns-hosto:8080",
        "apiKey": "eyJ0exxxxxxxxxx4",
        "authorization": "eyJhbxxxxxxxxxxg"
      },
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000,
      "updatedAtDateString": "2024-01-31T00:00:00.000Z",
      "updatedAt": 1706659200000
    }
  ]
}

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...