Skip to content

README.md

Latest commit

 

History

History
103 lines (73 loc) · 7.57 KB

README.md

File metadata and controls

103 lines (73 loc) · 7.57 KB

Connector.Apis

Overview

Available Operations

List

List APIs

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    apiKey: "<YOUR_BEARER_TOKEN_HERE>"
);

ConnectorApisAllResponse? res = await sdk.Connector.Apis.ListAsync(
    limit: 20,
    filter: new ApisFilter() {
        Status = ApiStatus.Beta,
    }
);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter Type Required Description Example
AppId string ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
Cursor string ➖ Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Limit long ➖ Number of results to return. Minimum 1, Maximum 200, Default 20
Filter ApisFilter ➖ Apply filters {
"status": "beta"
}

Response

ConnectorApisAllResponse

Errors

Error Type Status Code Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse 400 application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse 401 application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse 402 application/json
ApideckUnifySdk.Models.Errors.APIException 4XX, 5XX */*

Get

Get API

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;

var sdk = new Apideck(
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    apiKey: "<YOUR_BEARER_TOKEN_HERE>"
);

var res = await sdk.Connector.Apis.GetAsync(id: "<id>");

// handle response

Parameters

Parameter Type Required Description Example
Id string ✔️ ID of the record you are acting upon.
AppId string ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX

Response

ConnectorApisOneResponse

Errors

Error Type Status Code Content Type
ApideckUnifySdk.Models.Errors.UnauthorizedResponse 401 application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse 402 application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse 404 application/json
ApideckUnifySdk.Models.Errors.APIException 4XX, 5XX */*