Skip to content

README.md

Latest commit

 

History

History
110 lines (80 loc) · 9.91 KB

README.md

File metadata and controls

110 lines (80 loc) · 9.91 KB

Connectors

Overview

Retrieve metadata for connectors.

Available Operations

  • ListMeta - List Connector Meta Information
  • GetMeta - Get Connector Meta Information

ListMeta

List Connector Meta Information

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Connectors.ListMetaAsync(include: "field_path,unmapped_fields,resources,inactive,webhooks,static_fields");

// handle response

Parameters

Parameter Type Required Description Example
Include string ➖ The comma separated list of data that will be included in the response field_path,unmapped_fields,resources,inactive,webhooks,static_fields

Response

StackoneListConnectorsMetaResponse

Errors

Error Type Status Code Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException 400 application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException 401 application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException 403 application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException 404 application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException 408 application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException 409 application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException 422 application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException 429 application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse 500 application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException 501 application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException 502 application/json
StackOneHQ.Client.Models.Errors.APIException 4XX, 5XX */*

GetMeta

Get Connector Meta Information

Example Usage

using StackOneHQ.Client;
using StackOneHQ.Client.Models.Components;

var sdk = new StackOneHQClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Connectors.GetMetaAsync(
    provider: "<value>",
    include: "field_path,unmapped_fields,resources,inactive,webhooks,static_fields"
);

// handle response

Parameters

Parameter Type Required Description Example
Provider string ✔️ N/A
Include string ➖ The comma separated list of data that will be included in the response field_path,unmapped_fields,resources,inactive,webhooks,static_fields

Response

StackoneGetConnectorMetaResponse

Errors

Error Type Status Code Content Type
StackOneHQ.Client.Models.Errors.BadRequestResponseException 400 application/json
StackOneHQ.Client.Models.Errors.UnauthorizedResponseException 401 application/json
StackOneHQ.Client.Models.Errors.ForbiddenResponseException 403 application/json
StackOneHQ.Client.Models.Errors.NotFoundResponseException 404 application/json
StackOneHQ.Client.Models.Errors.RequestTimedOutResponseException 408 application/json
StackOneHQ.Client.Models.Errors.ConflictResponseException 409 application/json
StackOneHQ.Client.Models.Errors.UnprocessableEntityResponseException 422 application/json
StackOneHQ.Client.Models.Errors.TooManyRequestsResponseException 429 application/json
StackOneHQ.Client.Models.Errors.InternalServerErrorResponse 500 application/json
StackOneHQ.Client.Models.Errors.NotImplementedResponseException 501 application/json
StackOneHQ.Client.Models.Errors.BadGatewayResponseException 502 application/json
StackOneHQ.Client.Models.Errors.APIException 4XX, 5XX */*