Warning
This SDK is DEPRECATED
Retrieve metadata for connectors.
get_connector_meta- Get Connector Meta Information (Legacy)⚠️ Deprecatedlist_connectors_meta- List Connector Meta Information (Legacy)⚠️ Deprecated
Get Connector Meta Information (Legacy)
⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
require 'stackone_client'
Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
security: Models::Shared::Security.new(
password: '',
username: ''
)
)
res = s.connectors.get_connector_meta(provider: '<value>', include: 'field_path,unmapped_fields,resources,inactive,webhooks,static_fields')
unless res.connectors_meta.nil?
# handle response
end| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
provider |
::String | ✔️ | N/A | |
include |
T.nilable(::String) | ➖ | The comma separated list of data that will be included in the response | field_path,unmapped_fields,resources,inactive,webhooks,static_fields |
T.nilable(Models::Operations::StackoneGetConnectorMetaResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::BadRequestResponse | 400 | application/json |
| Models::Errors::UnauthorizedResponse | 401 | application/json |
| Models::Errors::ForbiddenResponse | 403 | application/json |
| Models::Errors::NotFoundResponse | 404 | application/json |
| Models::Errors::RequestTimedOutResponse | 408 | application/json |
| Models::Errors::ConflictResponse | 409 | application/json |
| Models::Errors::UnprocessableEntityResponse | 422 | application/json |
| Models::Errors::TooManyRequestsResponse | 429 | application/json |
| Models::Errors::InternalServerErrorResponse | 500 | application/json |
| Models::Errors::NotImplementedResponse | 501 | application/json |
| Models::Errors::BadGatewayResponse | 502 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
List Connector Meta Information (Legacy)
⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
require 'stackone_client'
Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
security: Models::Shared::Security.new(
password: '',
username: ''
)
)
res = s.connectors.list_connectors_meta(include: 'field_path,unmapped_fields,resources,inactive,webhooks,static_fields')
unless res.connectors_metas.nil?
# handle response
end| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
include |
T.nilable(::String) | ➖ | The comma separated list of data that will be included in the response | field_path,unmapped_fields,resources,inactive,webhooks,static_fields |
T.nilable(Models::Operations::StackoneListConnectorsMetaResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::BadRequestResponse | 400 | application/json |
| Models::Errors::UnauthorizedResponse | 401 | application/json |
| Models::Errors::ForbiddenResponse | 403 | application/json |
| Models::Errors::NotFoundResponse | 404 | application/json |
| Models::Errors::RequestTimedOutResponse | 408 | application/json |
| Models::Errors::ConflictResponse | 409 | application/json |
| Models::Errors::UnprocessableEntityResponse | 422 | application/json |
| Models::Errors::TooManyRequestsResponse | 429 | application/json |
| Models::Errors::InternalServerErrorResponse | 500 | application/json |
| Models::Errors::NotImplementedResponse | 501 | application/json |
| Models::Errors::BadGatewayResponse | 502 | application/json |
| Errors::APIError | 4XX, 5XX | */* |